Workflows

Cancel a workflow execution

Stops one run and stamps it CANCELLED. The execution stays queryable — cancelling is a state change, not a delete. Addressed by execution id alone, so a caller holding one from a list does not need to carry the workflow id with it.

Requires the workflows:write scope — Create, edit, enable, and delete your automation workflows.

post/api/v1/workflows/executions/{execution_id}/cancel

Request

  • Base URL: https://api.sendly.now
  • URL: https://api.sendly.now/api/v1/workflows/executions/{execution_id}/cancel
  • Auth: one of:
    • HTTP bearer
    • API key in cookie better-auth.session_token
    • OAuth 2 (authorization code, authorization URL https://app.sendly.now/api/auth/oauth2/authorize, token URL https://app.sendly.now/api/auth/oauth2/token, scopes: workflows:write)

Path parameters

execution_idstring uuid required

Workflow execution id.

Response

Cancelled execution

completed_atstring date-time nullable required
contact_idstring uuid required
current_step_idstring uuid nullable required
exit_reasonstring nullable required
idstring uuid required
started_atstring date-time required
status'RUNNING' | 'WAITING' | 'COMPLETED' | 'EXITED' | 'FAILED' | 'CANCELLED' required
workflow_idstring uuid required

Changes

No recorded changes to this operation across all 1 revision of this API.