Update subscriber preference

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

subscriberId

string

required

parameter

string

required

Body

application/json

channel

object

Optional preferences for each channel type in the assigned workflow.

Show child attributes

channel.enabled

boolean

required

If channel is enabled or not

channel.type

enum<string>

required

Channel type through which the message is sent

Available options:

in_app,

email,

sms,

chat,

push

enabled

boolean

Indicates whether the workflow is fully enabled for all channels for the subscriber.

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

required

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

object[]

required

Triggers are the events that will trigger the workflow.

Show child attributes

data.template.triggers.identifier

string

required

The identifier of the trigger

data.template.triggers.type

enum<string>

required

The type of the trigger

Available options:

event

data.template.triggers.variables

object[]

required

The variables of the trigger

Show child attributes

data.template.triggers.variables.name

string

required

The name of the variable

data.template.triggers.variables.type

enum<string>

The type of the variable

Available options:

String,

Array,

Boolean

data.template.triggers.variables.value

object

The value of the variable

data.template.triggers.reservedVariables

object[]

The reserved variables of the trigger

Show child attributes

data.template.triggers.reservedVariables.type

enum<string>

required

The type of the reserved variable

Available options:

tenant,

actor

data.template.triggers.reservedVariables.variables

string[]

required

The reserved variables of the trigger

data.template.triggers.subscriberVariables

object[]

The subscriber variables of the trigger

Show child attributes

data.template.triggers.subscriberVariables.name

string

required

The name of the variable

data.template.triggers.subscriberVariables.type

enum<string>

The type of the variable

Available options:

String,

Array,

Boolean

data.template.triggers.subscriberVariables.value

object

The value of the variable