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

List contact topics

GET/contacts/{id}/topics
Autorização
AuthorizationToken Bearer · headerobrigatório

A BillionSend API key (bs_…).

Parâmetros de caminho
idstringobrigatório
comprimento mín. 1
Respostas
200

Every topic of the team with the contact's effective subscription and whether it was chosen explicitly

objectstringobrigatório
Valores permitidos:list
dataobject[]obrigatório
Mostrar propriedades
Array de object
idstring<uuid>obrigatório
namestringobrigatório
descriptionstring | nullobrigatório
subscriptionstringobrigatório

Effective choice: the contact's explicit one, else the topic's default

Valores permitidos:opt_inopt_out
explicitbooleanobrigatório

True when the contact or the API chose this; false when it is the topic's default

visibilitystringobrigatório

The hosted preference page lists public topics only

Valores permitidos:publicprivate
has_morebooleanobrigatório
Valores permitidos:false
401

Missing, malformed, unknown or revoked API key

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
404

Not found

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/contacts/string/topics' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Resposta
{
  "object": "list",
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "description": "string",
      "subscription": "opt_in",
      "explicit": true,
      "visibility": "public"
    }
  ],
  "has_more": false
}

Esta página foi útil?