Execute a Workflow Batch

POST/workflows/{workflowDefinitionId}/execute

Triggers workflow execution for a batch of customers. Maximum 25 executions per request. For larger datasets, split into multiple requests.

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

Path Parameters

workflowDefinitionIdstringrequired

Workflow definition identifier to execute

Request Body

application/json

executionsarray of objectrequired

One to 25 executions. Duplicate phone-number strings in the same batch are rejected.

1–25 items

Show item detailsHide item details

Each item

phoneNumberstringrequired

Phone number in E.164 format (+1234567890) or digits-only format (1234567890)

Pattern: ^(^\+[1-9]\d{1,14}$|^[1-9]\d{1,14}$)$

variablesobject

Variables for the workflow execution

Show child fieldsHide child fields

[key]string

settingsobject

Accepted by request validation, but replaced with server-selected routing before the batch is queued. Omit this object. channelOverride is stripped and does not take effect for batches; use single execution for a supported override.

Show child fieldsHide child fields

channelstring

Messaging channel.

Allowed values"SMS""RCS""MMS"

providerstring

Messaging provider.

Allowed values"VONAGE""VIBES""TWILIO"

agentIdstring

Agent identifier.

agentReferenceIdstring

Agent reference identifier.

Responses

Batch accepted for processing

successbooleanrequired

Whether the batch was successfully queued

executionsarray of objectrequired

List of executions with their generated IDs

Show item detailsHide item details

Each item

phoneNumberstringrequired

Phone number for this execution

executionIdstringrequired

Generated execution ID for this workflow run

channelstring

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

Request Example

cURL Request

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

Execute workflow for multiple customers

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

Response Example 202

Response JSON

{
  "success": true,
  "executions": [
    {
      "phoneNumber": "15552223333",
      "executionId": "123e4567-e89b-12d3-a456-426614174000"
    },
    {
      "phoneNumber": "15552223334",
      "executionId": "987fcdeb-51a2-43d7-8f9e-123456789abc"
    }
  ]
}