Execute the Current Workflow Version

POST/workflows/family/{workflowFamilyId}/execute/{phoneNumber}

Execute the current version of a workflow family for a single phone number

Authenticate with your brand’s x-api-key.Authentication

Path Parameters

workflowFamilyIdstringrequired

ID of the workflow family to execute (will execute the current version)

phoneNumberstringrequired

Phone number of the customer to execute the workflow for

Request Body

application/json

variablesobject

Map of workflow variable names to string values. Keys must match the selected workflow. Omit when no variables are needed.

Show child fieldsHide child fields

[key]string

settingsobject

Workflow execution settings including channel overrides

Show child fieldsHide child fields

channelOverridestring

Channel override for the workflow execution

Allowed values"RCS""SMS"

Responses

Family workflow execution result

executionIdstring

Generated workflow run ID

successbooleanrequired

Whether the execution was successful

channelstring

Channel that will be used for message delivery (RCS, SMS, or MMS)

errorstring

Error message if execution failed

errorCodestring

Error code if execution failed

Allowed values"INVALID_ARGUMENT""RESOURCE_EXHAUSTED""WORKFLOW_ALREADY_STARTED""PAYLOAD_CONVERSION""UNKNOWN""WORKFLOW_NOT_FOUND""SAVE_FAILED""PREPARATION_FAILED""USER_ENGAGED"

detailsobject

Error-specific diagnostic object. Keys and value types vary by failure; no fixed set of properties is guaranteed.

Show child fieldsHide child fields

[key]any

Additional keys may contain any JSON value.

Request Example

cURL Request

curl --request POST \
  --url 'https://api.smobi.com/v1/workflows/family/wf_123e4567-e89b-12d3-a456-426614174000/execute/15552223333' \
  --header 'x-api-key: YOUR_BRAND_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{}'

Execute current version of workflow family

Run from your server or terminal. Examples use the production API.

Response Example 201

Response JSON

{
  "executionId": "run-123",
  "success": true,
  "channel": "RCS"
}