Workflows

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

GETList workflow automationsworkflows.list
POSTCreate a draft workflow automationworkflows.create
GETGet a workflow and its latest definitionworkflows.retrieve
DELETEDelete a workflow that is not publishedworkflows.delete
POSTStop a workflow for one contact without stopping the workflowworkflows.contacts.stop
DELETEResume a workflow for one stopped contactworkflows.contacts.stop.delete
POSTPublish a workflow automationworkflows.publish
GETList durable workflow runs and outcomesworkflows.runs.list
POSTStop one durable workflow run without stopping the workflowworkflows.runs.stop
POSTStop a workflow automationworkflows.stop
POSTStart an isolated workflow test runworkflows.test
POSTCreate an immutable workflow versionworkflows.versions

List workflow automations

GET/v1/accounts/{AC}/workflows

workflows.listSDK operation getV1AccountsByAcWorkflows

Required scope: inboxes:read.Paginated

Parameters

limitinteger (1–100)query
cursorstring (max 2048 chars)query

GET /v1/accounts/{AC}/workflows

curl "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/workflows" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21"

Responses

Create a draft workflow automation

POST/v1/accounts/{AC}/workflows

workflows.createSDK operation postV1AccountsByAcWorkflows

Required scope: inboxes:write.Idempotency-Key required

Request body

definitionobjectRequired
Show 5 child attributes
- actionsobject[]Required
- conditionsobject[]Required
- triggerobjectRequired
- failureActionsobject[]
- timeoutActionsobject[]
namestring (max 160 chars)Required

POST /v1/accounts/{AC}/workflows

curl -X POST "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/workflows" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "definition": {
    "actions": [],
    "conditions": [],
    "trigger": {}
  },
  "name": "string"
}'

Responses

Get a workflow and its latest definition

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

workflows.retrieveSDK operation getV1AccountsByAcWorkflowsByWf

Required scope: inboxes:read.

Parameters

WFstring (WF… SID)Required

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

curl "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/workflows/WF..." \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21"

Responses

Delete a workflow that is not published

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

workflows.deleteSDK operation deleteV1AccountsByAcWorkflowsByWf

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

WFstring (WF… SID)Required

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

curl -X DELETE "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/workflows/WF..." \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21"

Responses

Stop a workflow for one contact without stopping the workflow

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

workflows.contacts.stopSDK operation postV1AccountsByAcWorkflowsByWfContactsByCtStop

Required scope: inboxes:write.Idempotency-Key required

Parameters

WFstring (WF… SID)Required
CTstring (CT… SID)Required

Request body

reasonstring (max 500 chars)

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

curl -X POST "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/workflows/WF.../contacts/CT.../stop" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)"

Responses

Resume a workflow for one stopped contact

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

workflows.contacts.stop.deleteSDK operation deleteV1AccountsByAcWorkflowsByWfContactsByCtStop

Required scope: inboxes:write.

Parameters

WFstring (WF… SID)Required
CTstring (CT… SID)Required

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

curl -X DELETE "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/workflows/WF.../contacts/CT.../stop" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21"

Responses

Publish a workflow automation

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

workflows.publishSDK operation postV1AccountsByAcWorkflowsByWfPublish

Required scope: inboxes:write.Idempotency-Key required

Parameters

WFstring (WF… SID)Required

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

curl -X POST "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/workflows/WF.../publish" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)"

Responses

List durable workflow runs and outcomes

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

workflows.runs.listSDK operation getV1AccountsByAcWorkflowsByWfRuns

Required scope: inboxes:read.Paginated

Parameters

WFstring (WF… SID)Required
limitinteger (1–100)query
cursorstring (max 2048 chars)query

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

curl "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/workflows/WF.../runs" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21"

Responses

Stop one durable workflow run without stopping the workflow

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

workflows.runs.stopSDK operation postV1AccountsByAcWorkflowsByWfRunsByWrStop

Required scope: inboxes:write.Idempotency-Key required

Parameters

WFstring (WF… SID)Required
WRstring (WR… SID)Required

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

curl -X POST "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/workflows/WF.../runs/WR.../stop" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)"

Responses

Stop a workflow automation

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

workflows.stopSDK operation postV1AccountsByAcWorkflowsByWfStop

Required scope: inboxes:write.Idempotency-Key required

Parameters

WFstring (WF… SID)Required

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

curl -X POST "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/workflows/WF.../stop" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)"

Responses

Start an isolated workflow test run

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

workflows.testSDK operation postV1AccountsByAcWorkflowsByWfTest

A dry run: the run walks the workflow's actions in order and records each as a step with detail.dryRun, but sends nothing and changes no contact, conversation or tag. A contact stopped for this workflow cannot be used for a test.

Required scope: inboxes:write.Idempotency-Key required

Parameters

WFstring (WF… SID)Required

Request body

eventTypestring (pattern ^[A-Z][A-Z0-9_]{2,63}$)Required
contactSidstring (CT… SID)
conversationSidstring (CO… SID)
messageSidstring (SM… SID)
payloadobject

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

curl -X POST "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/workflows/WF.../test" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "eventType": "string"
}'

Responses

Create an immutable workflow version

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

workflows.versionsSDK operation postV1AccountsByAcWorkflowsByWfVersions

Required scope: inboxes:write.Idempotency-Key required

Parameters

WFstring (WF… SID)Required

Request body

actionsobject[]Required
conditionsobject[]Required
triggerobjectRequired
Show 3 child attributes
- eventTypesstring (pattern ^[A-Z][A-Z0-9_]{2,63}$)[]Required
- allowReentryboolean
- timeoutSecondsinteger (1–2592000)
failureActionsobject[]
timeoutActionsobject[]

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

curl -X POST "https://api.staging.toutye.com/v1/accounts/$TOUTYE_ACCOUNT_SID/workflows/WF.../versions" \
  -H "Authorization: Bearer $TOUTYE_API_KEY" \
  -H "Toutye-Version: 2026-08-21" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
  "actions": [],
  "conditions": [],
  "trigger": {
    "eventTypes": []
  }
}'

Responses