Add Contacts to Segment
mautic.add_contacts_to_segment
ActionCRM & salesconnection required
Calls the Mautic API with the connection's credentials.
Add many contacts to a segment in one call and report which ones Mautic took.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- OAuth 2.0
- Providers
- Mautic
- Secret shape
- {"client_id": "…", "client_secret": "…", "refresh_token": "…"}
- Config it needs
- base_url
- Resolved by
- config.connection_id, else node.connection_id
Configuration
2 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 |
|---|---|---|---|---|---|
segment_id The segment to add the contacts to. | string | Yes | — | — | 4 |
contact_ids Contact ids to add, as a JSON array or a comma-separated list. | array | Yes | — | array of integer | [1,2,3] |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"contact_ids": [
1,
2,
3
],
"segment_id": "4"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
success True when Mautic accepted the request as a whole. | boolean | — |
details Mautic's per-contact outcome, keyed by contact id. | object | — |
requested The contact ids that were sent. | array | — |
succeeded Contact ids Mautic added to the segment. | array | — |
failed Contact ids Mautic refused, usually for lack of access. | array | — |
partial True when some contacts were added and some were not. | boolean | — |
segment_id The segment the contacts were added to. | number | — |
{
"details": {},
"failed": [],
"partial": false,
"requested": [],
"segment_id": 0,
"succeeded": [],
"success": false
}See Add Contacts to Segment run in a workflow.
In a technical demo we add the Mautic connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.