Skip to content
Esc
↑↓navigate↵open⌘Jpreview

Remove in bulk

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

A BillionSend API key (bs_…).

Request body
requiredapplication/json
emailsstring<email>[]

Addresses to unblock, up to 1000

min items 1 · max items 1000
idsstring<uuid>[]

Suppression ids to remove, up to 1000

min items 1 · max items 1000
Responses
200

Exactly one of emails or ids (up to 1000 each); lists only the rows actually removed. Rows whose address was erased (GDPR/LGPD) keep blocking sends but are hidden from the list and from lookups by email; they are reachable by id only.

dataRemoveSuppressionResponse[]required
Show properties
Array of RemoveSuppressionResponse
objectstringrequired
Allowed:suppression
idstring<uuid>required
deletedbooleanrequired
Allowed:true
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/remove' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "emails": [
    "user@example.com"
  ],
  "ids": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ]
}'
Response
{
  "data": [
    {
      "object": "suppression",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "deleted": true
    }
  ]
}

Was this page helpful?