Toggle Workflow
POST/api/automation/workflows/:workflow/toggle
Toggle a workflow between published (trigger live) and disabled (trigger paused). Only workflows in one of those two states can be toggled - draft workflows must be published first.
settings:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Path param: workflow = workflow id.
Returns 422 with the graph errors when publishing a workflow whose graph is invalid.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Unprocessable Content
Response Headers
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.