Create Segment
mailchimp.create_segment
ActionEmailconnection required
Calls the Mailchimp API with the connection's credentials.
Create a segment on an audience. Supply 'static_segment' for a fixed list of addresses, or 'options' for a saved segment whose membership Mailchimp recalculates from its conditions.
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
4 fields, 2 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 | — | — | — |
name The segment name. | string | Yes | — | — | — |
static_segment Email addresses to put in a static segment, as a JSON array of strings. Every address must already be in the audience. | array | No | — | array of string | — |
options Saved-segment rules, as a JSON object: {"match": "any"|"all", "conditions": [ … ]}. Leave both this and static_segment empty to create an empty static segment. | object | No | — | — | — |
Output
One shape.
result
| Field | Type | Example |
|---|---|---|
id The segment id. | number | — |
name The segment name. | string | — |
member_count How many members are currently in the segment. | number | — |
type 'saved', 'static' or 'fuzzy'. | string | — |
created_at When the segment was created, ISO 8601. | string | — |
updated_at When the segment was last updated, ISO 8601. | string | — |
options The match rule and conditions, for a saved segment. | object | — |
list_id The audience the segment belongs to. | string | — |
{
"created_at": "",
"id": 0,
"list_id": "",
"member_count": 0,
"name": "",
"options": {},
"type": "",
"updated_at": ""
}See Create 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.