MailchimpList campaigns
Lists campaigns, filtered by type, status, audience or send time.
Settings
| Setting | What it is |
|---|---|
| ConnectionRequired | The Mailchimp connection the step signs in with. |
| Type | "" or "regular" or "plaintext" or "absplit" or "rss" or "variate" |
| Status | "" or "save" or "paused" or "schedule" or "sending" or "sent" |
| Audience id | Picked from the list Mailchimp offers. |
| Folder id | text |
| Contact id | Only campaigns this contact was sent. |
| Sent since | text |
| Sent before | text |
| Created since | text |
| Created before | text |
| Sort on | "" or "create_time" or "send_time" |
| Sort direction | "" or "ASC" or "DESC" |
| Fields to fetch | Mailchimp returns everything unless you name the fields you want. |
| Campaigns per call | 1 to 1,000. |
| Skip this many | number |
| Fetch every page | Walks Mailchimp's pages, and refuses past 5,000 campaigns rather than answering a short list. |
| Cursor | Paste a previous run's Next cursor to read the page after it. |
Technical details
| Key | Value |
|---|---|
connection | texta connection id from `requires.connections` (provider `mailchimp`) |
type | "" or "regular" or "plaintext" or "absplit" or "rss" or "variate" |
status | "" or "save" or "paused" or "schedule" or "sending" or "sent" |
audienceId | texta value from the vendor's own list |
folderId | text |
memberId | text |
sinceSendTime | text |
beforeSendTime | text |
sinceCreateTime | text |
beforeCreateTime | text |
sortField | "" or "create_time" or "send_time" |
sortDir | "" or "ASC" or "DESC" |
fields | text |
limit | number, by default 100 |
offset | number, by default 0 |
returnAll | true/false, by default false |
cursor | text |
Output
| Field | Type |
|---|---|
campaigns | array |
campaignCountCampaigns in this answer | number |
hasMoreMore campaigns are waiting behind this page | boolean |
totalItemsCampaigns in total | number |
nextCursorCursor for the next page | string |
Sample output, and the expression for each field
- campaignCount0
- campaigns[]
- hasMorefalse
- totalItems0
Errors
When a step of this node stops a run, the run page shows a code. Look it up:
Example step
The step as a flow file holds it. Replace each value in <…>.
{
"config": {
"audienceId": "",
"beforeCreateTime": "",
"beforeSendTime": "",
"connection": "<connection id>",
"cursor": "",
"fields": "",
"folderId": "",
"limit": 100,
"memberId": "",
"offset": 0,
"returnAll": false,
"sinceCreateTime": "",
"sinceSendTime": "",
"sortDir": "",
"sortField": "",
"status": "",
"type": ""
},
"label": "List campaigns",
"type": "mailchimp.listCampaigns",
"version": 2
}Older versions
A flow that already has this version keeps running it. A new step always gets the newest.
Version 1
| Setting | What it is |
|---|---|
| ConnectionRequired | The Mailchimp connection the step signs in with. |
| Type | "" or "regular" or "plaintext" or "absplit" or "rss" or "variate" |
| Status | "" or "save" or "paused" or "schedule" or "sending" or "sent" |
| Audience id | Picked from the list Mailchimp offers. |
| Folder id | text |
| Contact id | Only campaigns this contact was sent. |
| Sent since | text |
| Sent before | text |
| Created since | text |
| Created before | text |
| Sort on | "" or "create_time" or "send_time" |
| Sort direction | "" or "ASC" or "DESC" |
| Fields to fetch | Mailchimp returns everything unless you name the fields you want. |
| Campaigns per call | 1 to 1,000. |
| Skip this many | number |
| Fetch every page | Walks Mailchimp's pages, and refuses past 5,000 campaigns rather than answering a short list. |
Technical details
| Key | Value |
|---|---|
connection | texta connection id from `requires.connections` (provider `mailchimp`) |
type | "" or "regular" or "plaintext" or "absplit" or "rss" or "variate" |
status | "" or "save" or "paused" or "schedule" or "sending" or "sent" |
audienceId | texta value from the vendor's own list |
folderId | text |
memberId | text |
sinceSendTime | text |
beforeSendTime | text |
sinceCreateTime | text |
beforeCreateTime | text |
sortField | "" or "create_time" or "send_time" |
sortDir | "" or "ASC" or "DESC" |
fields | text |
limit | number, by default 100 |
offset | number, by default 0 |
returnAll | true/false, by default false |