MailchimpList contacts
Lists the contacts of an audience, filtered by status, date or interest.
Settings
| Setting | What it is |
|---|---|
| ConnectionRequired | The Mailchimp connection the step signs in with. |
| Audience id | Picked from the list Mailchimp offers. |
| Status | "" or "subscribed" or "unsubscribed" or "cleaned" or "pending" or "transactional" or "archived" |
| E-mail format | "" or "html" or "text" |
| Changed since | text |
| Changed before | text |
| Opted in since | text |
| Opted in before | text |
| Unsubscribed since | Mailchimp only accepts this filter together with the Unsubscribed status. |
| Sent to since | text |
| Unique e-mail id | Mailchimp's own id for an address across every audience. |
| VIPs only | true/false |
| Interest group id | From List interest categories. Needed by the two fields below. |
| Interest ids | Comma separated. Mailchimp needs an interest group id beside them. |
| Interest match | "" or "any" or "all" or "none" |
| Sort on | "" or "timestamp_opt" or "timestamp_signup" or "last_changed" |
| Sort direction | "" or "ASC" or "DESC" |
| Fields to fetch | Mailchimp returns everything unless you name the fields you want. On a page of 1,000 this is the difference between fitting this run's size limit and not. |
| Contacts per call | 1 to 1,000. |
| Skip this many | Mailchimp pages by position, not by cursor. |
| Fetch every page | Walks Mailchimp's pages, and refuses past 5,000 contacts rather than answering a short list. Mailchimp pages by position, so an audience that changes while the walk runs can repeat or skip a contact. |
| 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`) |
audienceId | texta value from the vendor's own list |
status | "" or "subscribed" or "unsubscribed" or "cleaned" or "pending" or "transactional" or "archived" |
emailType | "" or "html" or "text" |
sinceLastChanged | text |
beforeLastChanged | text |
sinceTimestampOpt | text |
beforeTimestampOpt | text |
unsubscribedSince | text |
sinceLastCampaign | text |
uniqueEmailId | text |
vipOnly | true/false, by default false |
interestCategoryId | text |
interestIds | text |
interestMatch | "" or "any" or "all" or "none" |
sortField | "" or "timestamp_opt" or "timestamp_signup" or "last_changed" |
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 |
|---|---|
membersContacts | array |
memberCountContacts in this answer | number |
hasMoreMore contacts are waiting behind this page | boolean |
totalItemsContacts in total | number |
nextCursorCursor for the next page | string |
Sample output, and the expression for each field
- hasMorefalse
- memberCount0
- members[]
- 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": "",
"beforeLastChanged": "",
"beforeTimestampOpt": "",
"connection": "<connection id>",
"cursor": "",
"emailType": "",
"fields": "",
"interestCategoryId": "",
"interestIds": "",
"interestMatch": "",
"limit": 100,
"offset": 0,
"returnAll": false,
"sinceLastCampaign": "",
"sinceLastChanged": "",
"sinceTimestampOpt": "",
"sortDir": "",
"sortField": "",
"status": "",
"uniqueEmailId": "",
"unsubscribedSince": "",
"vipOnly": false
},
"label": "List contacts",
"type": "mailchimp.listMembers",
"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. |
| Audience id | Picked from the list Mailchimp offers. |
| Status | "" or "subscribed" or "unsubscribed" or "cleaned" or "pending" or "transactional" or "archived" |
| E-mail format | "" or "html" or "text" |
| Changed since | text |
| Changed before | text |
| Opted in since | text |
| Opted in before | text |
| Unsubscribed since | Mailchimp only accepts this filter together with the Unsubscribed status. |
| Sent to since | text |
| Unique e-mail id | Mailchimp's own id for an address across every audience. |
| VIPs only | true/false |
| Interest group id | From List interest categories. Needed by the two fields below. |
| Interest ids | Comma separated. Mailchimp needs an interest group id beside them. |
| Interest match | "" or "any" or "all" or "none" |
| Sort on | "" or "timestamp_opt" or "timestamp_signup" or "last_changed" |
| Sort direction | "" or "ASC" or "DESC" |
| Fields to fetch | Mailchimp returns everything unless you name the fields you want. On a page of 1,000 this is the difference between fitting this run's size limit and not. |
| Contacts per call | 1 to 1,000. |
| Skip this many | Mailchimp pages by position, not by cursor. |
| Fetch every page | Walks Mailchimp's pages, and refuses past 5,000 contacts rather than answering a short list. Mailchimp pages by position, so an audience that changes while the walk runs can repeat or skip a contact. |
Technical details
| Key | Value |
|---|---|
connection | texta connection id from `requires.connections` (provider `mailchimp`) |
audienceId | texta value from the vendor's own list |
status | "" or "subscribed" or "unsubscribed" or "cleaned" or "pending" or "transactional" or "archived" |
emailType | "" or "html" or "text" |
sinceLastChanged | text |
beforeLastChanged | text |
sinceTimestampOpt | text |
beforeTimestampOpt | text |
unsubscribedSince | text |
sinceLastCampaign | text |
uniqueEmailId | text |
vipOnly | true/false, by default false |
interestCategoryId | text |
interestIds | text |
interestMatch | "" or "any" or "all" or "none" |
sortField | "" or "timestamp_opt" or "timestamp_signup" or "last_changed" |
sortDir | "" or "ASC" or "DESC" |
fields | text |
limit | number, by default 100 |
offset | number, by default 0 |
returnAll | true/false, by default false |