workflows

Cancel one in-progress workflow run

Stops a queued, running or waiting run before its remaining steps. Emails already handed to sending are not recalled and other runs are untouched. Cancelling a run that already ended is a no-op that returns cancelled=false.

post/workflows/{workflowKey}/runs/{runId}/cancel

Request

  • Base URL: https://api.mailly.site (the document declares no server; this is the origin it was published from)
  • URL: https://api.mailly.site/workflows/{workflowKey}/runs/{runId}/cancel
  • Auth: HTTP bearer

Path parameters

workflowKeystring required
runIdstring required

run ID

Request body

reasonstring

Why the run is cancelled, kept in the run log (1-500 characters)

Response

Cancelled, or already ended

successboolean required
cancelledboolean required
runobject required
platformFailuresstring[] required

Changes

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