Newer Version Available

This content describes an older version of this product. View Latest

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 Details
individualId
Type
string
Description
Required. The ID of the individual data model object (DMO).
flowVersionId
Type
string
Description
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
Type
string
Description
A description of the action, for example, the reason that the individual is removed from the flow.

Outputs

None

Usage

Sample Input