Execute Family

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

x-api-keystring

API Key authentication via header

workflowFamilyIdstringRequired

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

phoneNumberstringRequired

Phone number of the customer to execute the workflow for

Family workflow execution request

variablesobjectOptional

Optional variables for the workflow execution. The workflow family's current version will be executed.

settingsobjectOptional

Workflow execution settings including channel overrides

Family workflow execution result

successboolean

Whether the execution was successful

executionIdstring or null

Generated workflow run ID

channelstring or null

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

errorstring or null

Error message if execution failed

errorCodeenum or null

Error code if execution failed

detailsobject or null

Additional error details

1	import requests
2
3	url = "https://api.smobi.com/v1/workflows/family/wf_123e4567-e89b-12d3-a456-426614174000/execute/15552223333"
4
5	payload = { "variables": {
6	"customerName": "John Doe",
7	"orderId": "12345",
8	"discountCode": "SAVE20"
9	} }
10	headers = {
11	"x-api-key": "<apiKey>",
12	"Content-Type": "application/json"
13	}
14
15	response = requests.post(url, json=payload, headers=headers)
16
17	print(response.json())