Get subscriber preferences

Authorizations

Authorization

string

header

required

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

Headers

idempotency-key

string

A header for idempotency purposes

Path Parameters

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

preference

object

required

The preferences of the subscriber regarding the related workflow

Show child attributes

preference.channels

object

required

Subscriber preferences for the different channels regarding this workflow

Show child attributes

preference.channels.chat

boolean

preference.channels.email

boolean

preference.channels.in_app

boolean

preference.channels.push

boolean

preference.channels.sms

boolean

preference.enabled

boolean

required

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

template

object

required

The workflow information and if it is critical or not

Show child attributes

template._id

string

required

Unique identifier of the workflow

template.critical

boolean

required

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

template.name

string

required

Name of the workflow

template.triggers

object[]

required

Triggers are the events that will trigger the workflow.

Show child attributes

template.triggers.identifier

string

required

The identifier of the trigger

template.triggers.type

enum<string>

required

The type of the trigger

Available options:

event

template.triggers.variables

object[]

required

The variables of the trigger

Show child attributes

template.triggers.variables.name

string

required

The name of the variable

template.triggers.variables.type

enum<string>

The type of the variable

Available options:

String,

Array,

Boolean

template.triggers.variables.value

object

The value of the variable

template.triggers.reservedVariables

object[]

The reserved variables of the trigger

Show child attributes

template.triggers.reservedVariables.type

enum<string>

required

The type of the reserved variable

Available options:

tenant,

actor

template.triggers.reservedVariables.variables

string[]

required

The reserved variables of the trigger

template.triggers.subscriberVariables

object[]

The subscriber variables of the trigger

Show child attributes

template.triggers.subscriberVariables.name

string

required

The name of the variable

template.triggers.subscriberVariables.type

enum<string>

The type of the variable

Available options:

String,

Array,

Boolean

template.triggers.subscriberVariables.value

object

The value of the variable