API ReferenceWorkflows

Execute Single

Execute a workflow for a single phone number with simplified request format

Path parameters

workflowDefinitionIdstringRequired
ID of the workflow definition to execute
phoneNumberstringRequired
Phone number of the customer to execute the workflow for

Request

This endpoint expects an object.
variablesmap from strings to anyOptional
Optional variables for the workflow execution
settingsobjectOptional
Workflow execution settings including channel overrides

Response

Single workflow execution result
successboolean
Whether the execution was successful
workflowExecutionIdstring or null
Generated workflow run ID
errorstring or null
Error message if execution failed
errorCodeenum or null
Error code if execution failed
detailsmap from strings to any or null
Additional error details

Errors