Execute a stored workflow for visible contacts

Requires verified identity, workspace binding and complete contact visibility validation before dispatch. Released callers may omit requestId and retain legacy single-request and response semantics, including partial-success/manual-duplicate limits. Legacy validation uses 200-row ownership reads and at most 25 visibility checks concurrently; total request latency remains a release gate. Requests with a UUID requestId are limited to 500 contacts and use 24-hour per-contact task keys. New browsers negotiate and use batch-execute-v2; no POST failure is retried through the legacy endpoint.

POST

https://api.channelautomation.com/api/unified-workflow/batch-execute

Authorization

BearerAuth
optional
HTTP Bearer (JWT)

BackendTriggerAuth
optional
API key in header

Header parameters

X-Workspace-Id
string
required

Request body JSON required

workflowId
string
required
format: uuid
workspaceId
string
required
contactIds
array of
string
required
format: uuid
requestId
optional
string
Optional legacy compatibility; when present reuse for retries and submit at most 500 contacts

format: uuid
isTest
optional
boolean

Returns

200

Existing successful result

400

Invalid resource input or workflow override

401

Missing or invalid caller identity

403

Workspace conflict or contact visibility denied

404

Resource not found in the selected workspace

502

No submissions confirmed; retry with the same requestId

503

Identity

Execute a stored workflow for visible contacts

curl --request POST \
  --url https://api.channelautomation.com/api/unified-workflow/batch-execute \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Workspace-Id: string' \
  --data '
{
  "workflowId": "43c4fa9b-0cbc-4b57-a121-9d7d46a3eaa4",
  "workspaceId": "string",
  "contactIds": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ],
  "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
  "isTest": true
}
'

const url = 'https://api.channelautomation.com/api/unified-workflow/batch-execute';
const options = {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'X-Workspace-Id': 'string',
    Authorization: 'Bearer <token>'
  },
  body: JSON.stringify({
    workflowId: '43c4fa9b-0cbc-4b57-a121-9d7d46a3eaa4',
    workspaceId: 'string',
    contactIds: ['497f6eca-6276-4993-bfeb-53cbbbba6f08'],
    requestId: 'd385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6',
    isTest: true
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.channelautomation.com/api/unified-workflow/batch-execute"

payload = {
    "workflowId": "43c4fa9b-0cbc-4b57-a121-9d7d46a3eaa4",
    "workspaceId": "string",
    "contactIds": ["497f6eca-6276-4993-bfeb-53cbbbba6f08"],
    "requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
    "isTest": True
}
headers = {
    "Content-Type": "application/json",
    "X-Workspace-Id": "string",
    "Authorization": "Bearer <token>"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)