Workflows

Pause a workflow and cancel its running executions

Disables the workflow and cancels every RUNNING/WAITING execution inside it.

PATCH { "enabled": false } stops NEW runs starting and leaves every in-flight contact walking the graph — the next delay still expires, the next email still sends. Pausing does both, and reports how many runs it stopped.

Cancelling is terminal: resume re-opens the workflow to new runs, it does not put the cancelled contacts back where they were.

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

post/api/v1/workflows/{id}/pause

Request

  • Base URL: https://api.sendly.now
  • URL: https://api.sendly.now/api/v1/workflows/{id}/pause
  • 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

idstring uuid required

Workflow id.

Response

The workflow, and the number of runs this call cancelled

cancelled_executionsinteger required

Runs stopped by this call. Always 0 for resume; on pause it is the number of RUNNING/WAITING executions that were cancelled, which is what makes pausing different from PATCH { enabled: false } (that only stops NEW runs starting).

Changes

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