Get a Demo
  • Getting Started
    • Introduction
    • Quick Start Guide
    • Brand Setup & Configuration
    • TypeScript SDK
  • Core Features
    • Workflow Builder
    • Customer Management
    • Analytics & Reporting
  • Integration & Testing
    • Webhooks Setup
    • Testing & Playground
  • Support & Resources
    • Troubleshooting
    • Support & Resources
  • API Reference
Get a Demo
LogoLogo
API ReferenceWorkflows

POST
/workflows/:workflowDefinitionId/execute/:phoneNumber
POST
/v1/workflows/:workflowDefinitionId/execute/:phoneNumber
1curl -X POST https://api.smobi.com/v1/workflows/wf_123e4567-e89b-12d3-a456-426614174000/execute/15552223333 \
2 -H "x-smobi-test: x-smobi-test" \
3 -H "x-api-key: <apiKey>" \
4 -H "Content-Type: application/json" \
5 -d '{
6 "variables": {
7 "customerName": "John Doe",
8 "orderId": "12345",
9 "discountCode": "SAVE20"
10 }
11}'
Try it
201Created
1{
2 "success": true,
3 "executionId": "run-123",
4 "error": "Invalid phone number",
5 "errorCode": "INVALID_ARGUMENT",
6 "details": {}
7}
Was this page helpful?
Previous

Execute Batch

Next
Built with
Execute a workflow for a single phone number
Execute Single

Authentication

x-api-keystring
API Key authentication via header

Path parameters

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

Headers

x-smobi-teststringRequired

Request

Single workflow execution request
variablesobjectOptional
Optional variables for the workflow execution
settingsobjectOptional
Workflow execution settings including channel overrides

Response

Single workflow execution result
successboolean
Whether the execution was successful
executionIdstring or null
Generated workflow run ID
errorstring or null
Error message if execution failed
errorCodeenum or null
Error code if execution failed
detailsobject or null
Additional error details

Errors

Single workflow execution request
Single workflow execution result