Skip to main content
POST
Create a topic

Authorizations

Authorization
string
header
required

An API key from the dashboard. The scopes listed on each operation are the resource:action grants a key needs (messages:send, subscribers:read, topics:*, *); account:* scopes and key management are session-only. Workspace keys (bk_ws_) reach every tenant and pick one with the buzzkit-tenant header; tenant keys (bk_tn_) are locked to one tenant; client keys (bk_pk_) ship inside an app and only work on /v1/client/*.

Body

slug
string
required
Required string length: 3 - 48
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
name
string
required
Required string length: 1 - 100
description
string
Maximum string length: 500
category
string
Maximum string length: 100
dailyCap
integer
Required range: 1 <= x <= 50
channels
enum<string>[]
Minimum array length: 1
Available options:
push,
email
defaultOptedIn
boolean
channelDefaults
object

Response

Response for status 200

success
boolean
required
data
object | null
required
error
object | null
required
metadata
object
required