Skip to main content
POST
/
v1
/
sends
/
{sendId}
/
cancel
Cancel a send
curl --request POST \
  --url https://brew.new/api/v1/sends/{sendId}/cancel \
  --header 'Authorization: Bearer <token>'
import requests

url = "https://brew.new/api/v1/sends/{sendId}/cancel"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)
const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://brew.new/api/v1/sends/{sendId}/cancel', 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/sends/{sendId}/cancel",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"net/http"
"io"
)

func main() {

url := "https://brew.new/api/v1/sends/{sendId}/cancel"

req, _ := http.NewRequest("POST", url, nil)

req.Header.Add("Authorization", "Bearer <token>")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://brew.new/api/v1/sends/{sendId}/cancel")
.header("Authorization", "Bearer <token>")
.asString();
require 'uri'
require 'net/http'

url = URI("https://brew.new/api/v1/sends/{sendId}/cancel")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
{
  "sendId": "snd_8fK2mQ4p",
  "status": "canceled"
}
{
"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": "sends"
}
}
{
"error": {
"code": "SEND_NOT_FOUND",
"type": "not_found",
"message": "No send was found with id 'snd_xxx'.",
"suggestion": "List sends with GET /v1/analytics/sends, or start one with POST /v1/sends.",
"docs": "https://docs.brew.new/api-reference/api/errors",
"param": "sendId"
}
}
{
"error": {
"code": "SEND_NOT_CANCELLABLE",
"type": "conflict",
"message": "Send 'snd_x' is 'sent' and can no longer be canceled, only 'scheduled' or 'queued' sends can be canceled.",
"suggestion": "Check the send status via GET /v1/analytics/sends?sendId=… before canceling.",
"docs": "https://docs.brew.new/api-reference/api/errors",
"param": "sendId"
}
}
{
"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

Authorization
string
header
default:Bearer brew_your_api_key
required

Send your Brew API key as Authorization: Bearer brew_xxx.

Headers

Idempotency-Key
string

Optional idempotency key for safe retries. Reusing the same key with the same request body returns the original response for 24 hours.

Required string length: 1 - 100

Path Parameters

sendId
string
required

Send id returned by POST /v1/sends.

Required string length: 1 - 64
Example:

"snd_8fK2mQ4p"

Response

The send is canceled (or was already canceled).

sendId
string
required
Minimum string length: 1
status
enum<string>
required
Available options:
canceled