Execute Batch

POST

https://api.smobi.com/v1/workflows/:workflowDefinitionId/execute

POST

/v1/workflows/:workflowDefinitionId/execute

1 curl -X POST https://api.smobi.com/v1/workflows/wf_123e4567-e89b-12d3-a456-426614174000/execute \
2      -H "Content-Type: application/json" \
3      -d '{
4   "executions": [
5     {
6       "phoneNumber": "15552223333",
7       "variables": {
8         "customer.name": {
9           "name": "customer.name",
10           "value": "John Doe"
11         },
12         "customer.phone": {
13           "name": "customer.phone",
14           "value": "15552223333"
15         }
16       }
17     }
18   ]
19 }'

Try it

1 {
2   "executions": {
3     "results": {
4       "total": 3,
5       "created": 2,
6       "errors": 1
7     },
8     "created": [
9       {
10         "phoneNumber": "+15552223333",
11         "variables": {
12           "customer.name": {
13             "name": "customer.name",
14             "value": "John Doe"
15           }
16         },
17         "data": {
18           "key": "value"
19         },
20         "workflowExecutionId": "wf_exec_123e4567-e89b-12d3-a456-426614174000"
21       }
22     ],
23     "errors": [
24       {
25         "phoneNumber": "+15552223334",
26         "variables": {
27           "customer.name": {
28             "name": "customer.name",
29             "value": "Jane Doe"
30           }
31         },
32         "data": {
33           "key": "value"
34         },
35         "code": "PREPARATION_FAILED",
36         "message": "Workflow is not active. Current status: DRAFT",
37         "details": {
38           "workflowStatus": "DRAFT",
39           "requiredStatus": "ACTIVE"
40         }
41       }
42     ]
43   }
44 }

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

Path parameters

workflowDefinitionIdstringRequired

Workflow definition identifier to execute

Request

This endpoint expects an object.

executionslist of objectsRequired

Array of workflow executions to process

Response

Batch accepted for processing

executionsobject

Results of the workflow execution batch

Path parameters

Request

Response

Errors