Zum Inhalt springen
Esc
↑↓navigieren↵öffnen⌘Jvorschau

List contact topics

GET/contacts/{id}/topics
Autorisierung
AuthorizationBearer-Token · headererforderlich

A BillionSend API key (bs_…).

Pfadparameter
idstringerforderlich
min. Länge 1
Antworten
200

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

objectstringerforderlich
Erlaubt:list
dataobject[]erforderlich
Eigenschaften anzeigen
Array von object
idstring<uuid>erforderlich
namestringerforderlich
descriptionstring | nullerforderlich
subscriptionstringerforderlich

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

Erlaubt:opt_inopt_out
explicitbooleanerforderlich

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

visibilitystringerforderlich

The hosted preference page lists public topics only

Erlaubt:publicprivate
has_morebooleanerforderlich
Erlaubt:false
401

Missing, malformed, unknown or revoked API key

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
404

Not found

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
429

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

statusCodenumbererforderlich
namestringerforderlich
messagestringerforderlich
Ausprobieren
Server
Autorisierung
Parameter
Anfrage
curl -X GET 'https://api.billionsend.com/contacts/string/topics' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json'
Antwort
{
  "object": "list",
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "description": "string",
      "subscription": "opt_in",
      "explicit": true,
      "visibility": "public"
    }
  ],
  "has_more": false
}

War diese Seite hilfreich?