Skip to main content
POST
Create or update the preference-center configuration

Authorizations

Authorization
string
header
required

Dashboard JWT token from Clerk

Body

application/json
companyName
string
required

Name shown on the hosted page.

enabled
boolean
default:true

Whether the hosted preference page is live.

logoUrl
string

Logo image URL (http/https only).

primaryColor
string

Brand colour as a 6-digit hex value (e.g. #2563eb).

headerText
string

Heading shown at the top of the page.

Footer copy shown beneath the preferences.

channels
string[]

Channels a contact can opt in or out of.

showFrequencyOptions
boolean

Whether to show the send-frequency selector.

showGdprDelete
boolean

Whether to offer the "delete my data" action.

redirectUrl
string

Optional URL to redirect to after opt-out (http/https only).

topics
object[]

Subscription topics/groups the contact can manage.

Response

201 - application/json

The saved preference-center configuration.

data
object

The stored preference-center configuration.

meta
object