Zum Inhalt springen
Esc
↑↓navigieren↵öffnen⌘Jvorschau

Add suppressions in bulk

POST/suppressions/batch/add
Autorisierung
AuthorizationBearer-Token · headererforderlich

A BillionSend API key (bs_…).

Request-Body
erforderlichapplication/json
emailsstring<email>[]erforderlich

Addresses to block, up to 1000; duplicates collapse

min. 1 Elemente · max. 1000 Elemente
originstring

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

Erlaubt:bouncecomplaintmanual
Antworten
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[]erforderlich
Eigenschaften anzeigen
Array von SuppressionIdResponse
objectstringerforderlich
Erlaubt:suppression
idstring<uuid>erforderlich
401

Missing, malformed, unknown or revoked API key

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
422

Validation error

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
429

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

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
Ausprobieren
Server
Autorisierung
Bodyapplication/json
Anfrage
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"
}'
Antwort
{
  "data": [
    {
      "object": "suppression",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
  ]
}

War diese Seite hilfreich?