Skip to documentation

API · Automations

Stop Automation

Disable an automation to prevent new runs (requires full access). Existing runs continue to completion.

POST/automations/{automation_id}/stopFull access

Request parameters

ParameterTypeDescription
automation_id
path · required
stringThe ID of the automation.
Idempotency-Key
header · optional
string
1–256 characters
Makes the request safe to retry. See Idempotency.

Request example

Set OPENSEND_BASE_URL=https://api.example.com and OPENSEND_API_KEY=os_replace_me on your server.

bash
curl -X POST "$OPENSEND_BASE_URL/automations/YOUR_automation_id/stop" \
  -H "Authorization: Bearer $OPENSEND_API_KEY"

Response

200 · application/json. Example IDs stand for IDs returned by your installation.

json
{
  "object": "automation",
  "id": "YOUR_ID",
  "status": "disabled"
}

Behavior and errors

Stop disables new starts. Existing runs finish using their saved snapshots; this does not cancel individual runs.

Use a full-access credential. Unknown or foreign resources return 404. See authentication, errors, rate limits, and pagination.