Skip to content
Esc
↑↓navigate↵open⌘Jpreview

Add in bulk

POST/suppressions/batch/add
Authorization
AuthorizationBearer token · headerrequired

A BillionSend API key (bs_…).

Request body
requiredapplication/json
emailsstring<email>[]required

Addresses to block, up to 1000; duplicates collapse

min items 1 · max items 1000
originstring

Origin recorded on rows this request creates (default manual): bounce, complaint or manual; an address already suppressed keeps its origin

Allowed:bouncecomplaintmanual
Responses
200

One entry per distinct address (case-insensitive) in input order; addresses already suppressed return their existing id and keep their origin. New rows record the request's origin (bounce, complaint or manual; default manual). Accepts up to 1000 addresses.

dataSuppressionIdResponse[]required
Show properties
Array of SuppressionIdResponse
objectstringrequired
Allowed:suppression
idstring<uuid>required
401

Missing, malformed, unknown or revoked API key

statusCodenumberrequired
namestringrequired
messagestringrequired
422

Validation error

statusCodenumberrequired
namestringrequired
messagestringrequired
429

Over the rate limit (rate_limit_exceeded, with Retry-After)

statusCodenumberrequired
namestringrequired
messagestringrequired
Try it
Server
Authorization
Bodyapplication/json
Request
curl -X POST 'https://api.billionsend.com/suppressions/batch/add' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "emails": [
    "user@example.com"
  ],
  "origin": "bounce"
}'
Response
{
  "data": [
    {
      "object": "suppression",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
  ]
}

Was this page helpful?