Docs
/
/

Get object preference set

Returns the preference set for the specified object and preference set `id`.

Get object preference set

Returns the preference set for the specified object and preference set id.

Endpoint

GET/v1/objects/{collection}/{object_id}/preferences/{id}

Rate limit

Tier 4

Path parameters

object_id
string

Unique identifier for the object.

collection
string

The collection this object belongs to.

id
string

Unique identifier for the preference set.

Returns

A preference set represents a specific set of notification preferences for a recipient. A recipient can have multiple preference sets.

categories
PreferenceSetCategories

An object where the key is the category and the values are the preference settings for that category.

An object where the key is the channel type and the values are the preference settings for that channel type.

channels
PreferenceSetChannels

An object where the key is the channel ID and the values are the preference settings for that channel ID.

commercial_subscribed
boolean

Whether the recipient is subscribed to commercial communications. When false, the recipient will not receive commercial workflow notifications.

id
string

Unique identifier for the preference set.

workflows
PreferenceSetWorkflows

An object where the key is the workflow key and the values are the preference settings for that workflow.

New chat