POST/v1/workflows/runs/{id}/cancel

Stop a running workflow run

Stops one run that is still going, at its next step. The steps it already took STAND — nothing it did is undone. This ends one execution, not the rule: a rule that should stop firing at all is archived through patch_workflows_id.

Access class: workspace:admin.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Bearer tokensessionoptional

Stored only in this browser for the session security scheme and reused on every API page in this group.

Parameters

Values are applied to the request and the example on the right.

idpath · stringrequired

Request body

application/jsonrequired

bodyobjectoptional

paramsoptional

queryobjectoptional

Responses

201application/json

the action's answer

{
  "data": {
    "run": {
      "claimedAt": "string",
      "claimedBy": "string",
      "context": "string",
      "createdAt": "string",
      "cursorStep": 1,
      "errorText": "string",
      "finishedAt": "string",
      "id": 1,
      "nextAttemptAt": "string",
      "startedAt": "string",
      "status": "string",
      "subjectDefinitionId": "",
      "subjectRowId": "",
      "triggerActivityId": 1,
      "triggerKind": "string",
      "updatedAt": "string",
      "version": 1,
      "versionId": 1,
      "workflowId": 1,
      "workflowKey": "string",
      "workflowName": "string"
    }
  }
}

dataoptional

defaultapplication/json

a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.

{
  "error": "string"
}

errorstringrequired

curl --request POST \ 'https://neo-app-api-prod-836053680024.us-central1.run.app/v1/workflows/runs/{id}/cancel' \ --header 'Content-Type: application/json' \ --data '{ "body": {}, "params": { ":id": "string" }, "query": {}}'

{ "data": { "run": { "claimedAt": "string", "claimedBy": "string", "context": "string", "createdAt": "string", "cursorStep": 1, "errorText": "string", "finishedAt": "string", "id": 1, "nextAttemptAt": "string", "startedAt": "string", "status": "string", "subjectDefinitionId": "", "subjectRowId": "", "triggerActivityId": 1, "triggerKind": "string", "updatedAt": "string", "version": 1, "versionId": 1, "workflowId": 1, "workflowKey": "string", "workflowName": "string" } }}