Send Email
iterable.send_email
ActionEmailconnection required
Calls the Iterable API with the connection's credentials.
Send one triggered campaign email to a user.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Iterable
- Secret shape
- the API key, or {"api_key": "…"}
- Config it needs
- region, base_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
7 fields, 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 |
|---|---|---|---|---|---|
campaign_id The triggered campaign to send. | integer | Yes | — | ≥ 1 | — |
recipient_email Who to send to. Provide this or 'recipient_user_id'. | string | No | — | email format | — |
recipient_user_id The recipient's userId. Provide this or 'recipient_email'. | string | No | — | — | — |
data_fields Values to merge into the template, as a JSON object. These override the profile's own fields. | object | No | — | — | — |
send_at Schedule the send, formatted 'yyyy-MM-dd HH:mm:ss'. A past time sends now. | string | No | — | — | — |
metadata Data to pass back through Iterable's webhooks, as a JSON object. It is not used to render the message. | object | No | — | — | — |
allow_repeat_marketing_sends Send even when this campaign already reached the recipient. | boolean | No | — | — | — |
- At least one of recipient_email, recipient_user_id must be set.
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
code Iterable's response code, 'Success' when the call was accepted. | string | — |
msg The human-readable message Iterable returned. | string | — |
params Any extra detail Iterable attached to the response. | object | — |
campaign_id The campaign that was sent. | number | — |
accepted True when Iterable accepted the send. | boolean | — |
{
"accepted": false,
"campaign_id": 0,
"code": "",
"msg": "",
"params": {}
}Notes
- The campaign must be a triggered campaign; a blast campaign is refused.
See Send Email run in a workflow.
In a technical demo we add the Iterable connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.