Get Batch Check
mailcheck.get_operation
ActionEmailconnection required
Calls the Mailcheck API with the connection's credentials.
Read how far a batch check has got, and its result URL once done.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- Bearer token
- Providers
- Mailcheck
- Secret shape
- the API key, or {"api_key": "…"}
- Resolved by
- config.connection_id, else node.connection_id
Configuration
1 field, 1 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
operation_name The operation name returned by mailcheck.check_emails. | string | Yes | — | — | operations/1234 |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"operation_name": "operations/1234"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
name The operation's name, which identifies it in later calls. | string | — |
done True once every address in the batch has been processed. | boolean | — |
total_count How many addresses the batch carries in total. | number | — |
processed_count How many addresses have been checked so far. | number | — |
free_limit_reached True when the account's free verification allowance stopped the batch. | boolean | — |
create_time When the batch was started, as an ISO-8601 timestamp. | string | — |
result_url URL the finished results can be downloaded from; empty until done is true. | string | — |
error_message Mailcheck's message when the batch failed; empty when it did not. | string | — |
operation Mailcheck's own operation object, exactly as returned. | object | — |
{
"create_time": "",
"done": false,
"error_message": "",
"free_limit_reached": false,
"name": "",
"operation": {},
"processed_count": 0,
"result_url": "",
"total_count": 0
}Related Mailcheck nodes
See Get Batch Check run in a workflow.
In a technical demo we add the Mailcheck connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.