Add Member to Segment
mailchimp.add_segment_member
ActionEmailconnection required
Calls the Mailchimp API with the connection's credentials.
Add an existing audience member to a static segment. A saved segment's membership comes from its conditions and cannot be edited this way.
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
3 fields, 3 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 |
|---|---|---|---|---|---|
list_id The audience (list) id, as shown in Mailchimp under Audience settings and returned as 'id' by Mailchimp: List Audiences. | string | Yes | — | — | — |
segment_id The static segment's id, as returned by Mailchimp: List Segments. | string | Yes | — | — | — |
email The member's email address. It must already be in the audience. | string | Yes | — | email format | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
id The member's subscriber hash — the MD5 of the lowercased email. | string | — |
email_address The member's email address as Mailchimp stores it. | string | — |
unique_email_id Mailchimp's account-wide id for this email address. | string | — |
full_name The member's full name, assembled from its merge fields. | string | — |
email_type The format this member receives: 'html' or 'text'. | string | — |
status subscribed, unsubscribed, cleaned, pending, transactional or archived. | string | — |
merge_fields The member's merge-field values, keyed by merge tag. | object | — |
interests Interest-group membership, keyed by interest id. | object | — |
stats Open and click rates for this member on this audience. | object | — |
list_id The audience this member belongs to. | string | — |
last_changed When the member was last updated, ISO 8601. | string | — |
timestamp_opt When the member opted in, ISO 8601, when known. | string | — |
member_rating Mailchimp's 1-5 engagement rating for the member. | number | — |
language The member's language code. | string | — |
vip Whether the member is marked VIP. | boolean | — |
{
"email_address": "",
"email_type": "",
"full_name": "",
"id": "",
"interests": {},
"language": "",
"last_changed": "",
"list_id": "",
"member_rating": 0,
"merge_fields": {},
"stats": {},
"status": "",
"timestamp_opt": "",
"unique_email_id": "",
"vip": false
}See Add Member to Segment 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.