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

List unsubscribes

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/unsubscribes
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.

domain_idstring<uuid>

Only opt-outs from this domain (one of your domains); omitted lists every opt-out of the team, whole-team ones included

Respostas
200

Opt-outs, newest first, optionally of one domain (domain_id). A row with domain null opts the address out of every domain of the team. Rows whose address was erased (GDPR/LGPD) keep blocking marketing mail but are hidden from the list; 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

The address; a tombstone for a recipient erased under GDPR/LGPD

domain_idstring<uuid> | nullobrigatório

The domain the opt-out is for; null for the whole team, or once that domain was deleted

domainstring | nullobrigatório

The domain's name; null for the whole team. A deleted domain's name stays, and its opt-outs apply again if the domain is added back

created_atstringobrigatório
has_morebooleanobrigatório
401

Missing, malformed, unknown or revoked API key

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
403

A key held to one domain asked for another domain's opt-outs

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/unsubscribes' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Resposta
{
  "object": "list",
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "email": "string",
      "domain_id": "b2f7354f-b74d-4332-ab10-1a5e3c56466c",
      "domain": "string",
      "created_at": "string"
    }
  ],
  "has_more": true
}

Esta página foi útil?