Get Campaign
mailchimp.get_campaign
ActionEmailconnection required
Calls the Mailchimp API with the connection's credentials.
Fetch one campaign's settings, recipients and status. This is how a workflow waits for a send to finish: status becomes 'sent'.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Mailchimp
- Secret shape
- the Mailchimp API key (…-<dc>)
- Config it needs
- dc
- 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 |
|---|---|---|---|---|---|
campaign_id The campaign id returned by Mailchimp: Create Campaign or List Campaigns. | string | Yes | — | — | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
id The campaign id, used by every other campaign node. | string | — |
web_id The id this campaign has in the Mailchimp web UI's URLs. | number | — |
type regular, plaintext, absplit, rss or variate. | string | — |
status save, paused, schedule, sending or sent. | string | — |
create_time When the campaign was created, ISO 8601. | string | — |
send_time When the campaign was sent, ISO 8601, once it has been. | string | — |
emails_sent How many emails this campaign has sent so far. | number | — |
archive_url The public archive URL for the sent campaign. | string | — |
recipients The audience and segment the campaign goes to. | object | — |
settings Subject line, title, from name, reply-to and template. | object | — |
tracking Which opens, clicks and analytics the campaign tracks. | object | — |
{
"archive_url": "",
"create_time": "",
"emails_sent": 0,
"id": "",
"recipients": {},
"send_time": "",
"settings": {},
"status": "",
"tracking": {},
"type": "",
"web_id": 0
}See Get Campaign run in a workflow.
In a technical demo we add the Mailchimp connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.