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

Create a topic

POST/topics
Autorização
AuthorizationToken Bearer · headerobrigatório

A BillionSend API key (bs_…).

Corpo da requisição
obrigatórioapplication/json
namestringobrigatório
comprimento mín. 1
descriptionstring
default_subscriptionstringobrigatório
Valores permitidos:opt_inopt_out
visibilitystring
Valores permitidos: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.

Respostas
200

Topic created

idstring<uuid>obrigatório
namestringobrigatório
descriptionstring
default_subscriptionstringobrigatório
Valores permitidos:opt_inopt_out
visibilitystringobrigatório
Valores permitidos:privatepublic
domain_idstring<uuid> | nullobrigatório

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

created_atstringobrigatório
401

Missing, malformed, unknown or revoked API key

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
403

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

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
422

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

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
Corpoapplication/json
Requisição
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"
}'
Resposta
{
  "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"
}

Esta página foi útil?