Skip to main content
PATCH
cURL
Update a catalog entry’s name, description and default_enabled. The natural key (channel/topic/event/medium) is immutable — to change it, delete the entry and create a new one.

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.

Path Parameters

preference_id
integer
required

The catalog entry's ID.

Body

application/json

Updates a catalog entry's name, description, default and mandatory flag. The natural key (channel/topic/event/medium) is immutable.

name
string
required

Human-readable name for the catalog entry (e.g. "Weekly digest").

default_enabled
boolean
required
description
string

Optional longer blurb shown alongside the name on a settings screen. Omitted or blank stores none.

mandatory
boolean
default:false

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

The updated catalog entry.