Remove People From Segment
customer_io.remove_from_segment
ActionCRM & salesconnection required
Calls the Customer.io API with the connection's credentials.
Remove up to 1000 people from a manual segment. The people themselves are untouched; only the membership changes.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- Customer.io
- Secret shape
- {"site_id": "…", "api_key": "…", "app_api_key": "…"} — the Site ID and Track API key for the Track nodes, the App API key for the rest
- Config it needs
- region, workspace_id
- Resolved by
- config.connection_id, else node.connection_id
Configuration
3 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 numeric id of the segment, from its page in the dashboard under Usage. | string | Yes | — | — | 12 |
ids The people to remove, as a JSON array of identifiers. Every value must be of the kind named by 'id_type'. At least one is required. | array | Yes | — | ≥ 1 characters; array of string | ["42","43"] |
id_type Which identifier the 'ids' array holds. Customer.io assumes 'id' when this is blank and ignores entries of another kind. | string | No | — | one of "id", "email", "cio_id" | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"ids": [
"42",
"43"
],
"segment_id": "12"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
accepted True when Customer.io queued the write. Track writes are applied asynchronously, so this reports acceptance, not that the change is live. | boolean | — |
segment_id The segment the people were removed from. | number | — |
count How many identifiers the request carried. | number | — |
id_type The identifier kind that was declared, if any. | string | — |
{
"accepted": false,
"count": 0,
"id_type": "",
"segment_id": 0
}See Remove People From Segment run in a workflow.
In a technical demo we add the Customer.io connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.