Skip to main content
POST
cURL
Add one entry to your project’s preference catalog. Strict — creating an entry whose (channel, topic, event, medium) already exists returns 409. To change an existing entry use update; to declaratively set a whole catalog use bulk upsert.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer bv_xxxxxxxxx, where bv_xxxxxxxxx is your API Key with Full access scope.

Body

application/json
channel
string
required

Broad category (e.g. "digest").

topic
string
required

Subcategory. any matches all topics under the channel/event; none is the base channel/event.

event
string
required

Event that triggers the notification (e.g. "sent").

label
string
required

Human-readable label.

default_enabled
boolean
required

The project-level default for recipients who have set no preference of their own.

medium
enum<string>
default:in_app

The medium this catalog entry gates. Defaults to in_app.

Available options:
in_app,
email

Response

Catalog entry created.