curl --request PATCH \
--url https://brew.new/api/v1/automations/runs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"automationRunId": "run_01HZ",
"status": "canceled",
"reason": "Wrong segment — stopping before the second email."
}
'import requests
url = "https://brew.new/api/v1/automations/runs"
payload = {
"automationRunId": "run_01HZ",
"status": "canceled",
"reason": "Wrong segment — stopping before the second email."
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
automationRunId: 'run_01HZ',
status: 'canceled',
reason: 'Wrong segment — stopping before the second email.'
})
};
fetch('https://brew.new/api/v1/automations/runs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://brew.new/api/v1/automations/runs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'automationRunId' => 'run_01HZ',
'status' => 'canceled',
'reason' => 'Wrong segment — stopping before the second email.'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://brew.new/api/v1/automations/runs"
payload := strings.NewReader("{\n \"automationRunId\": \"run_01HZ\",\n \"status\": \"canceled\",\n \"reason\": \"Wrong segment — stopping before the second email.\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://brew.new/api/v1/automations/runs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"automationRunId\": \"run_01HZ\",\n \"status\": \"canceled\",\n \"reason\": \"Wrong segment — stopping before the second email.\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://brew.new/api/v1/automations/runs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"automationRunId\": \"run_01HZ\",\n \"status\": \"canceled\",\n \"reason\": \"Wrong segment — stopping before the second email.\"\n}"
response = http.request(request)
puts response.read_body{
"automationRunId": "run_01HZ",
"status": "canceled",
"previousStatus": "running"
}{
"error": {
"code": "INVALID_REQUEST",
"type": "invalid_request",
"message": "Request validation failed.",
"suggestion": "Fix the field reported in `param` and retry.",
"docs": "https://docs.brew.new/api-reference/api/errors",
"param": "status"
}
}{
"error": {
"code": "INVALID_API_KEY",
"type": "authentication_error",
"message": "The provided API key is invalid.",
"suggestion": "Check the API key format and retry with a valid active key.",
"docs": "https://docs.brew.new/api-reference/api/authentication"
}
}{
"error": {
"code": "INSUFFICIENT_PERMISSIONS",
"type": "authorization_error",
"message": "The caller does not have the required permission.",
"suggestion": "Use an API key or session with the required permission.",
"docs": "https://docs.brew.new/api-reference/api/authentication",
"param": "automations"
}
}{
"error": {
"code": "AUTOMATION_RUN_NOT_FOUND",
"type": "not_found",
"message": "Automation run 'run_xxx' was not found.",
"suggestion": "List runs with GET /v1/automations/runs.",
"docs": "https://docs.brew.new/api-reference/api/errors",
"param": "automationRunId"
}
}{
"error": {
"code": "RUN_NOT_CANCELLABLE",
"type": "conflict",
"message": "Automation run 'run_01HZ' is already completed and can no longer be canceled.",
"suggestion": "The run has already finished and can no longer be canceled.",
"docs": "https://docs.brew.new/api-reference/api/errors"
}
}{
"error": {
"code": "RATE_LIMITED",
"type": "rate_limit",
"message": "Too many requests.",
"suggestion": "Wait for the retry window before sending another request.",
"docs": "https://docs.brew.new/api-reference/api/rate-limits",
"retryAfter": 42
}
}{
"error": {
"code": "INTERNAL_ERROR",
"type": "internal_error",
"message": "An unexpected error occurred.",
"suggestion": "Retry the request. If it keeps failing, contact support.",
"docs": "https://docs.brew.new/api-reference/api/errors"
}
}Cancel an automation run
Operator cancel of ONE run (an event execution or a test run) by automationRunId in the body — the same flat identity the read uses. Marks the run canceled (first-terminal-wins: a late completion from the dying workflow can never overwrite it), wakes a run parked on a wait node so it observes the cancel now, and terminates the durable workflow run so a step stuck retrying is freed too. Nothing further is sent; emails already delivered are NOT recalled and a canceled run cannot be resumed. 409 RUN_NOT_CANCELLABLE when the run already finished (completed / failed / canceled); 404 AUTOMATION_RUN_NOT_FOUND for an unknown / cross-brand id. Manual-audience launches are controlled via POST /v1/automations/audience-runs/{audienceRunId}/control instead.
curl --request PATCH \
--url https://brew.new/api/v1/automations/runs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"automationRunId": "run_01HZ",
"status": "canceled",
"reason": "Wrong segment — stopping before the second email."
}
'import requests
url = "https://brew.new/api/v1/automations/runs"
payload = {
"automationRunId": "run_01HZ",
"status": "canceled",
"reason": "Wrong segment — stopping before the second email."
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
automationRunId: 'run_01HZ',
status: 'canceled',
reason: 'Wrong segment — stopping before the second email.'
})
};
fetch('https://brew.new/api/v1/automations/runs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://brew.new/api/v1/automations/runs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'automationRunId' => 'run_01HZ',
'status' => 'canceled',
'reason' => 'Wrong segment — stopping before the second email.'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://brew.new/api/v1/automations/runs"
payload := strings.NewReader("{\n \"automationRunId\": \"run_01HZ\",\n \"status\": \"canceled\",\n \"reason\": \"Wrong segment — stopping before the second email.\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://brew.new/api/v1/automations/runs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"automationRunId\": \"run_01HZ\",\n \"status\": \"canceled\",\n \"reason\": \"Wrong segment — stopping before the second email.\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://brew.new/api/v1/automations/runs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"automationRunId\": \"run_01HZ\",\n \"status\": \"canceled\",\n \"reason\": \"Wrong segment — stopping before the second email.\"\n}"
response = http.request(request)
puts response.read_body{
"automationRunId": "run_01HZ",
"status": "canceled",
"previousStatus": "running"
}{
"error": {
"code": "INVALID_REQUEST",
"type": "invalid_request",
"message": "Request validation failed.",
"suggestion": "Fix the field reported in `param` and retry.",
"docs": "https://docs.brew.new/api-reference/api/errors",
"param": "status"
}
}{
"error": {
"code": "INVALID_API_KEY",
"type": "authentication_error",
"message": "The provided API key is invalid.",
"suggestion": "Check the API key format and retry with a valid active key.",
"docs": "https://docs.brew.new/api-reference/api/authentication"
}
}{
"error": {
"code": "INSUFFICIENT_PERMISSIONS",
"type": "authorization_error",
"message": "The caller does not have the required permission.",
"suggestion": "Use an API key or session with the required permission.",
"docs": "https://docs.brew.new/api-reference/api/authentication",
"param": "automations"
}
}{
"error": {
"code": "AUTOMATION_RUN_NOT_FOUND",
"type": "not_found",
"message": "Automation run 'run_xxx' was not found.",
"suggestion": "List runs with GET /v1/automations/runs.",
"docs": "https://docs.brew.new/api-reference/api/errors",
"param": "automationRunId"
}
}{
"error": {
"code": "RUN_NOT_CANCELLABLE",
"type": "conflict",
"message": "Automation run 'run_01HZ' is already completed and can no longer be canceled.",
"suggestion": "The run has already finished and can no longer be canceled.",
"docs": "https://docs.brew.new/api-reference/api/errors"
}
}{
"error": {
"code": "RATE_LIMITED",
"type": "rate_limit",
"message": "Too many requests.",
"suggestion": "Wait for the retry window before sending another request.",
"docs": "https://docs.brew.new/api-reference/api/rate-limits",
"retryAfter": 42
}
}{
"error": {
"code": "INTERNAL_ERROR",
"type": "internal_error",
"message": "An unexpected error occurred.",
"suggestion": "Retry the request. If it keeps failing, contact support.",
"docs": "https://docs.brew.new/api-reference/api/errors"
}
}Authorizations
Send your Brew API key as Authorization: Bearer brew_xxx.
Headers
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.
1 - 64Body
The run to cancel (from GET /v1/automations/runs, a test start, or a fire response).
1 - 64The only PATCH action today — always canceled.
canceled Optional operator note stored on the run.
500Was this page helpful?