Exit Individuals from a Flow Action

Remove individuals from a single segment-triggered, automation event-triggered, or on-demand flow. This action is available in API version 66.0 and later.

For example, a flow sends automated reminder emails to an individual to complete a purchase. To prevent redundant communications and maintain a personalized customer journey after the purchase is complete, use this action to remove the individual from the flow.

Supported REST HTTP Methods

URI: /services/data/vXX.X/actions/custom/exitIndividualsFromFlow/flow_API_name

Formats: JSON, XML

HTTP Methods: POST

Authentication: Authorization: Bearer token

Inputs

Input	Type	Description
`individualId`	string	Required. The ID of the individual data model object (DMO).
`flowVersionId`	string	The version ID of the flow from which the individual is removed. If this field isn’t set, then the individual is exited from all running versions of the flow.
`description`	string	A description of the action, for example, the reason that the individual is removed from the flow.

Outputs

None

Usage

Sample Input

1{
2  "inputs": [
3    {
4      "individualId": "003R000000ExAmPlE",
5      "flowVersionId": "301R000000AbCdEfG",
6      "description": "Customer completed purchase via external portal."
7    }
8  ]
9}