Create a catalog entry
Create a single catalog entry. Strict: an entry for the same (channel, topic, event, medium) returns 409. Use PATCH /preferences/{preference_id} to change an existing entry, or PUT /preferences to set a whole catalog.
(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
Bearer authentication header of the form Bearer bv_xxxxxxxxx, where bv_xxxxxxxxx is your API Key with Full access scope.
Body
Broad category (e.g. "digest").
Subcategory. any matches all topics under the channel/event; none is the base channel/event.
Event that triggers the notification (e.g. "sent").
Human-readable name for the catalog entry (e.g. "Weekly digest").
The project-level default for recipients who have set no preference of their own.
The medium this catalog entry gates. Defaults to in_app.
in_app, email Optional longer blurb shown alongside the name on a settings screen. Omitted or blank stores none.
Whether recipients may opt out. A mandatory entry is cataloged (so sends pass the target gate) but its recipient toggle is refused with a 400, and any rule a recipient already had is ignored. For transactional notifications — password resets, security alerts, a one-shot welcome. default_enabled still applies, so setting it false stops the notification: mandatory removes the recipient's choice, not yours. Defaults to false.
Response
Catalog entry created.