API Reference

Stop Automation

POST /automations/:id/stop — stop an automation from creating new runs.

POST/automations/:id/stop

Stops an automation by setting its status to disabled. This prevents new runs from being created; existing in-progress runs continue to completion.

Path parameters

idstringrequired

The ID of the automation to stop.

import { MailBlastr } from 'mailblastr';

const mb = new MailBlastr('mb_xxxxxxxxx');

const { data, error } = await mb.automations.stop('c9b16d4f-ba6c-4e2e-b044-6bf4404e57fd');
console.log({ data, error });

Response

Returns the updated automation object with status set to disabled.

{
  "object": "automation",
  "id": "c9b16d4f-ba6c-4e2e-b044-6bf4404e57fd",
  "audience_id": "aud_3b1c...",
  "domain": "yourdomain.com",
  "name": "Welcome series",
  "trigger": "user.created",
  "status": "disabled",
  "created_at": "2026-06-23T10:00:00.000Z",
  "updated_at": "2026-06-23T10:02:00.000Z"
}

Stopping an automation prevents new runs from being created. Existing in-progress runs continue to completion.