Create a topic
POST
/topicsAuthorization
AuthorizationBearer token · headerrequiredA BillionSend API key (bs_…).
Request body
requiredapplication/jsonnamestringrequiredmin length 1
descriptionstringdefault_subscriptionstringrequiredAllowed:
opt_inopt_outvisibilitystringAllowed:
privatepublicdomain_idstring<uuid> | nullBillionSend 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.
Responses
200
Topic created
idstring<uuid>requirednamestringrequireddescriptionstringdefault_subscriptionstringrequiredAllowed:
opt_inopt_outvisibilitystringrequiredAllowed:
privatepublicdomain_idstring<uuid> | nullrequiredBillionSend extension: the domain the topic is bound to; null for a team-wide topic
created_atstringrequired401
Missing, malformed, unknown or revoked API key
statusCodenumberrequirednamestringrequiredmessagestringrequired403
A key held to one domain bound this to another domain, or unbound it
statusCodenumberrequirednamestringrequiredmessagestringrequired422
Validation error, or a domain_id that is not one of your domains
statusCodenumberrequirednamestringrequiredmessagestringrequired429
Over the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberrequirednamestringrequiredmessagestringrequired