Workflow node reference
Add to Segment
Add or remove contact from a segment. Exact configuration, outputs, execution behavior, errors, limits, and examples for the Add to Segment workflow node.
What this guide covers
- Category: Actions.
- Use it to add or remove the current contact from a selected or newly created segment.
- 4 configuration fields and 3 documented outputs.
- A standalone segment-management and bulk-audience UI was not found in the audited frontend.
What this node does
Add or remove contact from a segment
Use it to add or remove the current contact from a selected or newly created segment.
When not to use it
Do not use it for one-off labels; use Assign Tag.
Prerequisites
- Current contact context
- Existing segment or a valid new segment name
Current contact context. Existing segment or a valid new segment name
Inputs and configuration fields
| Field | Key | Control / type | Requirement | Default | Accepted values and behavior |
|---|---|---|---|---|---|
Action | action | select | Optional | add | Add to Segment (add), Remove from Segment (remove) |
Segment Source | segment_source | select | Optional | select | Select existing segment (select), Create new segment (create) |
Segment | segment_id | select | Optional | No default | shown when segment_source equals select |
New Segment Name | new_segment_name | text | Optional | No default | shown when segment_source equals create |
Configure the node
- Drag Add to Segment from Actions in the node palette.
- Select the node to open its configuration drawer.
- Complete every required field and any conditional field revealed by your choices.
- Insert variables only from the current trigger or an earlier node on the same path.
- Connect every required output handle to the intended next step.
- Save and run Workflow Test with representative data before activation.
Outputs
Later nodes can use these values only after this node has run successfully on the same execution path.
| Variable | Type | Meaning |
|---|---|---|
{{nodes.add_to_segment.success}} | boolean | Whether operation succeeded |
{{nodes.add_to_segment.segment_name}} | string | Name of the segment |
{{nodes.add_to_segment.segment_size}} | number | New segment size after operation |
Execution behavior
- Performs the configured add/remove operation.
- Emits success, segment name, and new segment size.
Do not assume a failed node is automatically retried. Review the execution result and the relevant service documentation before repeating an operation that could create a duplicate side effect.
Example use case
Add customers who choose product updates to a Newsletter Subscribers segment.
Send Interactive reply trigger → Condition → Add to Segment → Send TextCommon errors
| Symptom | Resolution |
|---|---|
Segment is unavailable | Select an existing segment or create a valid new one. |
Contact context is missing | Use a trigger/path that identifies a current contact. |
Limitations
A standalone segment-management and bulk-audience UI was not found in the audited frontend.
Treat this node as Limited until the required segment resource is available in your account.
A standalone segment-management and bulk-audience UI was not found in the audited frontend. Treat this node as Limited until the required segment resource is available in your account.