Aller au contenu
Esc
↑↓naviguer↵ouvrir⌘Japerçu

Create a topic

POST/topics
Autorisation
AuthorizationJeton Bearer · headerrequis

A BillionSend API key (bs_…).

Corps de la requête
requisapplication/json
namestringrequis
longueur min 1
descriptionstring
default_subscriptionstringrequis
Valeurs autorisées :opt_inopt_out
visibilitystring
Valeurs autorisées :privatepublic
domain_idstring<uuid> | null

BillionSend extension: id of one of your domains. The topic then appears only on that domain's unsubscribe page, and a send with this topic_id must come from that domain (422 otherwise). null or omitted: a topic of the whole team, shown for every domain. On update, null makes the topic a team-wide one again.

Réponses
200

Topic created

idstring<uuid>requis
namestringrequis
descriptionstring
default_subscriptionstringrequis
Valeurs autorisées :opt_inopt_out
visibilitystringrequis
Valeurs autorisées :privatepublic
domain_idstring<uuid> | nullrequis

BillionSend extension: the domain the topic is bound to; null for a team-wide topic

created_atstringrequis
401

Missing, malformed, unknown or revoked API key

statusCodenumberrequis
namestringrequis
messagestringrequis
403

A key held to one domain bound this to another domain, or unbound it

statusCodenumberrequis
namestringrequis
messagestringrequis
422

Validation error, or a domain_id that is not one of your domains

statusCodenumberrequis
namestringrequis
messagestringrequis
429

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

statusCodenumberrequis
namestringrequis
messagestringrequis
Essayer
Serveur
Autorisation
Corpsapplication/json
Requête
curl -X POST 'https://api.billionsend.com/topics' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "description": "string",
  "default_subscription": "opt_in",
  "visibility": "private",
  "domain_id": "b2f7354f-b74d-4332-ab10-1a5e3c56466c"
}'
Réponse
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "description": "string",
  "default_subscription": "opt_in",
  "visibility": "private",
  "domain_id": "b2f7354f-b74d-4332-ab10-1a5e3c56466c",
  "created_at": "string"
}

Cette page vous a-t-elle été utile ?