Create a topic
POST
/topicsAutorização
AuthorizationToken Bearer · headerobrigatórioA BillionSend API key (bs_…).
Corpo da requisição
obrigatórioapplication/jsonnamestringobrigatóriocomprimento mín. 1
descriptionstringdefault_subscriptionstringobrigatórioValores permitidos:
opt_inopt_outvisibilitystringValores permitidos:
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.
Respostas
200
Topic created
idstring<uuid>obrigatórionamestringobrigatóriodescriptionstringdefault_subscriptionstringobrigatórioValores permitidos:
opt_inopt_outvisibilitystringobrigatórioValores permitidos:
privatepublicdomain_idstring<uuid> | nullobrigatórioBillionSend extension: the domain the topic is bound to; null for a team-wide topic
created_atstringobrigatório401
Missing, malformed, unknown or revoked API key
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório403
A key held to one domain bound this to another domain, or unbound it
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório422
Validation error, or a domain_id that is not one of your domains
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório429
Over the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório