Actions Developer Guide

Introducing Actions
Action Objects
Apex Actions
Assign Enablement Program
Apply Case Classification Recommendations
B2B and D2C Commerce Actions
Cancel Approval Submission Action
Change Order Summary Preview
Change Order Summary Submit
Commerce Checkout Flow Actions
Convert Base64 Speech to Text Action
Create Service Document Actions
Create Service Report Actions
Custom Notification Actions
Deploy Data Kit Components Action
Email Alert Actions
Einstein Bots Actions
Exit Individuals from a Flow Action
Explore Conversation Actions
Flow Actions
Generate Order Summary Action
Generate Work Orders Actions
Get Assessment Response Summary
Get Conversation Intelligence Action
Get Conversation Transcript Action
Get Data Graph Data By Lookup
Get Data Graph Metadata
Knowledge Actions
Lead Action
Live Message Notification Actions
Omni-Channel Action
Apply Payment Action
Payment Sale Action
Perform Survey Sentiment Analysis
PlatformAction
Post to Chatter Actions
Preview Cart to Exchange Order
Prompt Template Actions
Quick Actions
Reassign Approval Work Item Action
Recall Approval Submission Action
Refresh Metric Actions
Review Approval Work Item Action
Sales Engagement Actions
Salesforce Omnichannel Inventory Actions
Salesforce Order Management Actions
Send Conversation Messages Actions
Send Notification Actions
Session-Based Permission Set Actions
Simple Email Actions
Speech to Text Action
Submit Exchange Order
Submit for Approval Actions
Survey Invitation Actions
Text to Speech Action (Beta)
Work Plan and Work Step Actions
PDF

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}