Skip to main content
POST
/
v1
/
contacts
/
batch-delete
Batch-delete contacts
curl --request POST \
  --url https://brew.new/api/v1/contacts/batch-delete \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "emails": [
    "jane@example.com",
    "gone@example.com"
  ]
}
'
{
  "deleted": 1,
  "notFound": [
    "gone@example.com"
  ]
}

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

Body

application/json
​
emails
string<email>[]
required
Required array length: 1 - 1000 elements

Response

Batch delete applied.

​
deleted
integer
required
Required range: x >= 0
​
notFound
string[]
Minimum string length: 1