Create or Replace Default Preferences For Topic

import Courier from '@trycourier/courier'; const client = new Courier({ apiKey: process.env['COURIER_API_KEY'], // This is the default and can be omitted }); await client.tenants.preferences.items.update('topic_id', { tenant_id: 'tenant_id', status: 'OPTED_IN', custom_routing: ['inbox'], has_custom_routing: true, });

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

tenant_id

string

required

Id of the tenant to update the default preferences for.

topic_id

string

required

Id of the subscription topic you want to have a default preference for.

Body

application/json

status

enum<string>

required

Available options:

OPTED_OUT,

OPTED_IN,

REQUIRED

has_custom_routing

boolean | null

Override channel routing with custom preferences. This will override any template preferences that are set, but a user can still customize their preferences

custom_routing

enum<string>[] | null

The default channels to send to this tenant when has_custom_routing is enabled

Available options:

direct_message,

email,

push,

sms,

webhook,

inbox

Response

204 - undefined