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

Add a suppression

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

A BillionSend API key (bs_…).

Corpo da requisição
obrigatórioapplication/json
emailstring<email>obrigatório

Bare email address to block; stored normalized (lowercase)

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

Address blocked with the given origin (bounce, complaint or manual; default manual). Idempotent: an address already suppressed keeps its entry and origin and its existing id is returned.

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' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "email": "user@example.com",
  "origin": "bounce"
}'
Resposta
{
  "object": "suppression",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
}

Esta página foi útil?