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>'
{
  "sendId": "snd_8fK2mQ4p",
  "status": "canceled"
}

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