Workflows

API reference descriptions are provided in English to preserve the exact published contract.

List workflow automations

GET /v1/accounts/{AC}/workflows

getV1AccountsByAcWorkflowsPaginated200

Required scope: `inboxes:read`.

Parameters

Parameters
Name	Type	Required	Description
`limit`	query · integer (1–100)
`cursor`	query · string (max 2048 chars)
`AC`	path · string (AC… SID)	yes	Account SID

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

Create a draft workflow automation

POST /v1/accounts/{AC}/workflows

postV1AccountsByAcWorkflowsIdempotency-Key required201

Required scope: `inboxes:write`.

Parameters

Parameters
Name	Type	Required	Description
`AC`	path · string (AC… SID)	yes	Account SID

Request body (7 fields)

Request body
Name	Type	Required
`definition`	object	yes
`definition.actions`	object[]	yes
`definition.conditions`	object[]	yes
`definition.failureActions`	object[]
`definition.timeoutActions`	object[]
`definition.trigger`	object	yes
`name`	string (max 160 chars)	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

Get a workflow and its latest definition

GET /v1/accounts/{AC}/workflows/{WF}

getV1AccountsByAcWorkflowsByWf200

Required scope: `inboxes:read`.

Parameters

Parameters
Name	Type	Required	Description
`AC`	path · string (AC… SID)	yes
`WF`	path · string (WF… SID)	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

Delete a workflow that is not published

DELETE /v1/accounts/{AC}/workflows/{WF}

deleteV1AccountsByAcWorkflowsByWf204

Removes a DRAFT or STOPPED workflow with its versions and finished runs. A PUBLISHED workflow must be stopped first; a workflow with RUNNING or WAITING runs is refused until those runs are stopped. Required scope: `inboxes:write`.

Parameters

Parameters
Name	Type	Required	Description
`AC`	path · string (AC… SID)	yes
`WF`	path · string (WF… SID)	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

Stop a workflow for one contact without stopping the workflow

POST /v1/accounts/{AC}/workflows/{WF}/contacts/{CT}/stop

postV1AccountsByAcWorkflowsByWfContactsByCtStopIdempotency-Key required200

Required scope: `inboxes:write`.

Parameters

Parameters
Name	Type	Required
`AC`	path · string (AC… SID)	yes
`WF`	path · string (WF… SID)	yes
`CT`	path · string (CT… SID)	yes

Request body (1 fields)

Request body
Name	Type	Required	Description
`reason`	string (max 500 chars)

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

Resume a workflow for one stopped contact

DELETE /v1/accounts/{AC}/workflows/{WF}/contacts/{CT}/stop

deleteV1AccountsByAcWorkflowsByWfContactsByCtStop204

Required scope: `inboxes:write`.

Parameters

Parameters
Name	Type	Required
`AC`	path · string (AC… SID)	yes
`WF`	path · string (WF… SID)	yes
`CT`	path · string (CT… SID)	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

Publish a workflow automation

POST /v1/accounts/{AC}/workflows/{WF}/publish

postV1AccountsByAcWorkflowsByWfPublishIdempotency-Key required200

Required scope: `inboxes:write`.

Parameters

Parameters
Name	Type	Required	Description
`AC`	path · string (AC… SID)	yes
`WF`	path · string (WF… SID)	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

List durable workflow runs and outcomes

GET /v1/accounts/{AC}/workflows/{WF}/runs

getV1AccountsByAcWorkflowsByWfRunsPaginated200

Required scope: `inboxes:read`.

Parameters

Parameters
Name	Type	Required
`limit`	query · integer (1–100)
`cursor`	query · string (max 2048 chars)
`AC`	path · string (AC… SID)	yes
`WF`	path · string (WF… SID)	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

Stop one durable workflow run without stopping the workflow

POST /v1/accounts/{AC}/workflows/{WF}/runs/{WR}/stop

postV1AccountsByAcWorkflowsByWfRunsByWrStopIdempotency-Key required200

Required scope: `inboxes:write`.

Parameters

Parameters
Name	Type	Required
`AC`	path · string (AC… SID)	yes
`WF`	path · string (WF… SID)	yes
`WR`	path · string (WR… SID)	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

Stop a workflow automation

POST /v1/accounts/{AC}/workflows/{WF}/stop

postV1AccountsByAcWorkflowsByWfStopIdempotency-Key required200

Required scope: `inboxes:write`.

Parameters

Parameters
Name	Type	Required	Description
`AC`	path · string (AC… SID)	yes
`WF`	path · string (WF… SID)	yes

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

Start an isolated workflow test run

POST /v1/accounts/{AC}/workflows/{WF}/test

postV1AccountsByAcWorkflowsByWfTestIdempotency-Key required201

Required scope: `inboxes:write`.

Parameters

Parameters
Name	Type	Required	Description
`AC`	path · string (AC… SID)	yes
`WF`	path · string (WF… SID)	yes

Request body (5 fields)

Request body
Name	Type	Required
`contactSid`	string (CT… SID)
`conversationSid`	string (CO… SID)
`eventType`	string (pattern ^[A-Z][A-Z0-9_]{2,63}$)	yes
`messageSid`	string (SM… SID)
`payload`	object

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.

Create an immutable workflow version

POST /v1/accounts/{AC}/workflows/{WF}/versions

postV1AccountsByAcWorkflowsByWfVersionsIdempotency-Key required201

Required scope: `inboxes:write`.

Parameters

Parameters
Name	Type	Required	Description
`AC`	path · string (AC… SID)	yes
`WF`	path · string (WF… SID)	yes

Request body (8 fields)

Request body
Name	Type	Required
`actions`	object[]	yes
`conditions`	object[]	yes
`failureActions`	object[]
`timeoutActions`	object[]
`trigger`	object	yes
`trigger.allowReentry`	boolean
`trigger.eventTypes`	string (pattern ^[A-Z][A-Z0-9_]{2,63}$)[]	yes
`trigger.timeoutSeconds`	integer (1–2592000)

Errors: 400, 401, 403, 404, 409, 422, 429, 500, 503 — see errors.