Execute Personalize Flow (callFlows)
sitecore_personalize_flow_executeExecute a published Personalize flow for a guest using browser ID, email, or custom identifiers, and retrieve real-time decision output to drive personalization.
Instructions
Triggers real-time decisioning execution of a published flow, identified by friendlyId, for a guest identified by exactly one of browserId, email, or identifiers — returning the flow's decision output. Equivalent to the Personalize interactive callFlows API.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| No | The guest's email. Use exactly one of browserId, email, or identifiers. | ||
| params | No | Optional custom fields passed into the flow's decisioning context. | |
| browserId | No | The guest's browser ID. Recommended identifier for flow execution — required for goal attribution to work correctly. Use exactly one of browserId, email, or identifiers. | |
| friendlyId | Yes | The friendly ID of the published flow to execute (set on the flow definition). | |
| identifiers | No | Custom guest identifiers object. Use exactly one of browserId, email, or identifiers. |