Skip to main content
PATCH
/
v1
/
automation
/
runs
Cancel an automation run
curl --request PATCH \
  --url https://brew.new/api/v1/automation/runs \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "automationRunId": "run_01HZ",
  "status": "cancelled",
  "reason": "recipient unsubscribed"
}
'
{
  "error": {
    "code": "NOT_IMPLEMENTED",
    "type": "not_implemented",
    "message": "This endpoint shell is ready, but the business logic is not implemented yet.",
    "suggestion": "Cancel is part of the P7 work; tracked in docs/email-automations-architecture.md §7.4.",
    "docs": "https://docs.brew.new/api-reference/api/errors"
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.brew.new/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

Authorization
string
header
default:Bearer brew_your_api_key
required

Send your Brew API key as Authorization: Bearer brew_xxx.

Body

application/json
automationRunId
string
required
Required string length: 1 - 64
status
enum<string>
required
Available options:
cancelled
reason
string
Maximum string length: 500

Response

501 - application/json

Cancel is being implemented (P7).

error
object
required