Cancel a workflow run in the selected workspace

Requires a verified current member session or configured backend automation credential. Source labels provide no authority. Resource IDs must belong to the selected workspace; member contact visibility is checked. Inline definitions and database-lookup bypasses are rejected.

POST

https://api.channelautomation.com/api/unified-workflow/cancel-workflow/{taskId}

Authorization

BearerAuth
optional
HTTP Bearer (JWT)

BackendTriggerAuth
optional
API key in header

Path parameters

taskId
string
required

Header parameters

X-Workspace-Id
string
required

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

503

Identity

Cancel a workflow run in the selected workspace

curl --request POST \
  --url 'https://api.channelautomation.com/api/unified-workflow/cancel-workflow/<taskId>' \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Workspace-Id: string'

const url = 'https://api.channelautomation.com/api/unified-workflow/cancel-workflow/<taskId>';
const options = {
  method: 'POST',
  headers: {'X-Workspace-Id': 'string', Authorization: 'Bearer <token>'}
};

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/cancel-workflow/<taskId>"

headers = {
    "X-Workspace-Id": "string",
    "Authorization": "Bearer <token>"
}

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

print(response.text)