Pular para o conteúdo
Esc
↑↓navegar↵abrir⌘Jpré-visualizar

Add in bulk

POST/suppressions/batch/add
Autorização
AuthorizationToken Bearer · headerobrigatório

A BillionSend API key (bs_…).

Corpo da requisição
obrigatórioapplication/json
emailsstring<email>[]obrigatório

Addresses to block, up to 1000; duplicates collapse

mín. 1 itens · máx. 1000 itens
originstring

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

Valores permitidos:bouncecomplaintmanual
Respostas
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[]obrigatório
Mostrar propriedades
Array de SuppressionIdResponse
objectstringobrigatório
Valores permitidos:suppression
idstring<uuid>obrigatório
401

Missing, malformed, unknown or revoked API key

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
422

Validation error

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
429

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

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
Experimentar
Servidor
Autorização
Corpoapplication/json
Requisição
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"
}'
Resposta
{
  "data": [
    {
      "object": "suppression",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
  ]
}

Esta página foi útil?