Saltar al contenido
Esc
↑↓navegar↵abrir⌘Jvista previa

Add suppressions in bulk

POST/suppressions/batch/add
Autorización
AuthorizationToken Bearer · headerobligatorio

A BillionSend API key (bs_…).

Cuerpo de la solicitud
obligatorioapplication/json
emailsstring<email>[]obligatorio

Addresses to block, up to 1000; duplicates collapse

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

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

Valores permitidos:bouncecomplaintmanual
Respuestas
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[]obligatorio
Mostrar propiedades
Array de SuppressionIdResponse
objectstringobligatorio
Valores permitidos:suppression
idstring<uuid>obligatorio
401

Missing, malformed, unknown or revoked API key

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
422

Validation error

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
429

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

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
Pruébalo
Servidor
Autorización
Cuerpoapplication/json
Solicitud
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"
}'
Respuesta
{
  "data": [
    {
      "object": "suppression",
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08"
    }
  ]
}

¿Te ha resultado útil esta página?