Flows

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

GETList Flowsflows.list
POSTCreate a local Flow draftflows.create
GETFetch a Flowflows.retrieve
PATCHEdit a Flow draftflows.update
POSTClone a Flow definition into a new editable draftflows.clone
POSTDeprecate a Flow through Metaflows.deprecate
POSTRotate the plaintext-signing secret for a gateway Flow endpointflows.endpoint.secret.rotate
GETList immutable Flow definition versionsflows.history.list
POSTPublish a Flow through Metaflows.publish
GETFlow endpoint and per-sender encryption-key readinessflows.readiness.list

List Flows

GET/v1/accounts/{AC}/flows

flows.listSDK operation getV1AccountsByAcFlows

Required scope: templates:read.Paginated

Parameters

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

GET /v1/accounts/{AC}/flows

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

Responses

Create a local Flow draft

POST/v1/accounts/{AC}/flows

flows.createSDK operation postV1AccountsByAcFlows

Required scope: templates:write.Idempotency-Key required

Request body

categoriesstring (max 64 chars)[]Required
definitionobjectRequired
namestring (max 256 chars)Required
wabaSidstring (WB… SID)Required
endpointModeenum
gatewaydirect
endpointPublicKeystring (max 8192 chars)
endpointUristring (uri, max 2048 chars)

POST /v1/accounts/{AC}/flows

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

Responses

Fetch a Flow

GET/v1/accounts/{AC}/flows/{FL}

flows.retrieveSDK operation getV1AccountsByAcFlowsByFl

Required scope: templates:read.

Parameters

FLstring (FL… SID)Required

GET /v1/accounts/{AC}/flows/{FL}

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

Responses

Edit a Flow draft

PATCH/v1/accounts/{AC}/flows/{FL}

flows.updateSDK operation patchV1AccountsByAcFlowsByFl

Required scope: templates:write.Idempotency-Key required

Parameters

FLstring (FL… SID)Required

Request body

categoriesstring (max 64 chars)[]
definitionobject
endpointModeenum
gatewaydirect
endpointPublicKeystring (max 8192 chars)
endpointUristring (uri, max 2048 chars)
namestring (max 256 chars)

PATCH /v1/accounts/{AC}/flows/{FL}

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

Responses

Clone a Flow definition into a new editable draft

POST/v1/accounts/{AC}/flows/{FL}/clone

flows.cloneSDK operation postV1AccountsByAcFlowsByFlClone

Required scope: templates:write.Idempotency-Key required

Parameters

FLstring (FL… SID)Required

Request body

namestring (max 256 chars)Required

POST /v1/accounts/{AC}/flows/{FL}/clone

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

Responses

Deprecate a Flow through Meta

POST/v1/accounts/{AC}/flows/{FL}/deprecate

flows.deprecateSDK operation postV1AccountsByAcFlowsByFlDeprecate

Required scope: templates:write.Idempotency-Key required

Parameters

FLstring (FL… SID)Required

POST /v1/accounts/{AC}/flows/{FL}/deprecate

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

Responses

Rotate the plaintext-signing secret for a gateway Flow endpoint

POST/v1/accounts/{AC}/flows/{FL}/endpoint/secret/rotate

flows.endpoint.secret.rotateSDK operation postV1AccountsByAcFlowsByFlEndpointSecretRotate

Required scope: templates:write.Idempotency-Key required

Parameters

FLstring (FL… SID)Required

POST /v1/accounts/{AC}/flows/{FL}/endpoint/secret/rotate

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

Responses

List immutable Flow definition versions

GET/v1/accounts/{AC}/flows/{FL}/history

flows.history.listSDK operation getV1AccountsByAcFlowsByFlHistory

Required scope: templates:read.Paginated

Parameters

FLstring (FL… SID)Required
limitinteger (1–100)query
cursorstring (max 2048 chars)query

GET /v1/accounts/{AC}/flows/{FL}/history

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

Responses

Publish a Flow through Meta

POST/v1/accounts/{AC}/flows/{FL}/publish

flows.publishSDK operation postV1AccountsByAcFlowsByFlPublish

Required scope: templates:write.Idempotency-Key required

Parameters

FLstring (FL… SID)Required

POST /v1/accounts/{AC}/flows/{FL}/publish

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

Responses

Flow endpoint and per-sender encryption-key readiness

GET/v1/accounts/{AC}/flows/{FL}/readiness

flows.readiness.listSDK operation getV1AccountsByAcFlowsByFlReadiness

Required scope: templates:read.

Parameters

FLstring (FL… SID)Required

GET /v1/accounts/{AC}/flows/{FL}/readiness

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

Responses