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

List suppressions

Newest first, with cursor pagination: after takes the last id of a page and pages toward older items, before takes the first id and pages back toward newer ones.

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

A BillionSend API key (bs_…).

Parâmetros de consulta
limitinteger

Page size, 1-100 (default 20)

mín. 1 · máx. 100
afterstring<uuid>

Cursor: id of the last item of the current page; returns the next page. Must be an id this list returned; there is no sentinel value.

beforestring<uuid>

Cursor: id of the first item of the current page; returns the previous page; same rule as after.

originstring

Only suppressions of this origin: bounce, complaint or manual

Valores permitidos:bouncecomplaintmanual
Respostas
200

Suppressions, optionally filtered by origin (bounce, complaint or manual). 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.

objectstringobrigatório
Valores permitidos:list
dataobject[]obrigatório
Mostrar propriedades
Array de object
idstring<uuid>obrigatório
emailstringobrigatório
originstringobrigatório
Valores permitidos:bouncecomplaintmanual
source_idstring<uuid> | nullobrigatório

Email id whose bounce/complaint created the entry

created_atstringobrigatório
has_morebooleanobrigató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
Parâmetros
Requisição
curl -X GET 'https://api.billionsend.com/suppressions' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Resposta
{
  "object": "list",
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "email": "string",
      "origin": "bounce",
      "source_id": "ae50a35c-df42-4eff-ba26-f8bc28d2af81",
      "created_at": "string"
    }
  ],
  "has_more": true
}

Esta página foi útil?