Skip to main content
PATCH
Cancel an automation run

Authorizations

Authorization
string
header
default:Bearer brew_your_api_key
required

Send your Brew API key as Authorization: Bearer brew_xxx.

Headers

X-Brand-Id
string

The brand this request acts on. REQUIRED for organization-scoped credentials (otherwise 400 BRAND_ID_REQUIRED — there is no default brand); list ids with GET /v1/brands. Brand-scoped credentials may omit it, and sending a different brand returns 403 BRAND_SCOPE_MISMATCH. A brand outside your organization returns 404 BRAND_NOT_FOUND.

Required string length: 1 - 64

Body

application/json
automationRunId
string
required

The run to cancel (from GET /v1/automations/runs, a test start, or a fire response).

Required string length: 1 - 64
status
enum<string>
required

The only PATCH action today — always canceled.

Available options:
canceled
reason
string

Optional operator note stored on the run.

Maximum string length: 500

Response

The run's new status plus the status it held before the cancel.

automationRunId
string
required
Required string length: 1 - 64
status
enum<string>
required
Available options:
canceled
previousStatus
enum<string>
required
Available options:
pending,
running,
completed,
failed,
canceled