Skip to content
Esc
↑↓navigate↵open⌘Jpreview

Create a topic

POST/topics
Authorization
AuthorizationBearer token · headerrequired

A BillionSend API key (bs_…).

Request body
requiredapplication/json
namestringrequired
min length 1
descriptionstring
default_subscriptionstringrequired
Allowed:opt_inopt_out
visibilitystring
Allowed: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.

Responses
200

Topic created

idstring<uuid>required
namestringrequired
descriptionstring
default_subscriptionstringrequired
Allowed:opt_inopt_out
visibilitystringrequired
Allowed:privatepublic
domain_idstring<uuid> | nullrequired

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

created_atstringrequired
401

Missing, malformed, unknown or revoked API key

statusCodenumberrequired
namestringrequired
messagestringrequired
403

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

statusCodenumberrequired
namestringrequired
messagestringrequired
422

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

statusCodenumberrequired
namestringrequired
messagestringrequired
429

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

statusCodenumberrequired
namestringrequired
messagestringrequired
Try it
Server
Authorization
Bodyapplication/json
Request
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"
}'
Response
{
  "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"
}

Was this page helpful?