Cancel a run in progress

DELETE /v1/automations/{id}/runs/{run_id}

The run stays readable, ended with end_reason canceled. 409 if it is advancing at this moment.

Send your API key as a bearer token: Authorization: Bearer ssms_sk_.... Test keys run this endpoint against the sandbox; see Authentication for key modes and scopes.

Path parameters

Name	Type	Required	Description
`id`	string	Yes
`run_id`	string	Yes

Responses

Status	Meaning	Body
200	Canceled run	`AutomationRun`
401	Missing, malformed, or revoked API key	`Error`
402	Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged	`Error`
429	Rate limit or quota exceeded	`Error`

200: `AutomationRun` fields

Field	Type	Description
`id`	string	Example: `run_1790000000000a1B2c3D4`.
`object`	`automation_run`
`automation_id`	string
`automation_version`	integer
`status`	`running`, `waiting`, `completed`, `failed`
`to`	string
`user_id`	string	Nullable.
`test`	boolean
`trigger_event`	string
`step`	integer	Index of the step the run is on.
`waiting_until`	string (date-time)	Nullable.
`waiting_for_event`	string	Nullable.
`end_reason`	`finished`, `end_step`, `branch_end`, `opted_out`, `flow_deleted`, `version_removed`, `expired`, `canceled`, `error`, `null`	Nullable.
`messages_sent`	integer
`messages_failed`	integer
`timeline`	array of object
`timeline[].at`	string (date-time)
`timeline[].type`	`started`, `sent`, `send_failed`, `send_unconfirmed`, `send_skipped`, `wait_started`, `wait_done`, `waiting_for_event`, `event_received`, `timed_out`, `condition_met`, `condition_not_met`, `ended`
`timeline[].step_id`	string
`timeline[].detail`	string
`timeline[].message_id`	string
`started_at`	string (date-time)
`ended_at`	string (date-time)	Nullable.

Errors

Status	When
401	Missing, malformed, or revoked API key
402	Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged
429	Rate limit or quota exceeded

Every error has the same JSON shape, and request_id matches the X-Request-Id response header. Errors lists every code and what to do about it.

json

{
  "error": {
    "code": "invalid_request",
    "message": "What went wrong, in plain words.",
    "param": "the_field",
    "request_id": "req_a1B2c3D4e5F6g7H8"
  }
}

Examples

curl

bash

curl -X DELETE "https://api.joinsimplesms.com/v1/automations/auto_a1B2c3D4e5F6/runs/run_1790000000000a1B2c3D4" \
  -H "Authorization: Bearer $SIMPLESMS_API_KEY"

Node.js

javascript

import { SimpleSMS } from 'joinsimplesms'; // npm install joinsimplesms

const sms = new SimpleSMS(process.env.SIMPLESMS_API_KEY);

await sms.automations.cancelRun('auto_a1B2c3D4e5F6', 'run_1790000000000a1B2c3D4');

Python

python

import os
from joinsimplesms import SimpleSMS  # pip install joinsimplesms

client = SimpleSMS(os.environ["SIMPLESMS_API_KEY"])

client.automations.cancel_run("auto_a1B2c3D4e5F6", "run_1790000000000a1B2c3D4")