Get subscriber preferences by level

Enter your API key in the Authorization field like the example shown below:

E.g ApiKey 18d2e625f05d80e

Authorizations

Authorization

string

header

required

API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".

Path Parameters

parameter

enum<string>

required

Fetch global or per workflow channel preferences

Available options:

global,

template

subscriberId

string

required

Query Parameters

includeInactiveChannels

boolean

A flag which specifies if the inactive workflow channels should be included in the retrieved preferences. Default is true

Response

200 - application/json

data

object[]

Show child attributes

data.preference

object

required

The preferences of the subscriber regarding the related workflow

Show child attributes

data.preference.channels

object

required

Subscriber preferences for the different channels regarding this workflow

Show child attributes

data.preference.channels.chat

boolean

data.preference.channels.email

boolean

data.preference.channels.in_app

boolean

data.preference.channels.push

boolean

data.preference.channels.sms

boolean

data.preference.enabled

boolean

required

Sets if the workflow is fully enabled for all channels or not for the subscriber.

data.template

object

The workflow information and if it is critical or not

Show child attributes

data.template._id

string

required

Unique identifier of the workflow

data.template.critical

boolean

required

Critical templates will always be delivered to the end user and should be hidden from the subscriber preferences screen

data.template.name

string

required

Name of the workflow

data.template.triggers

string[]

required

Triggers are the events that will trigger the workflow.