Update subscriber preference

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

E.g ApiKey 18d2e625f05d80e

Java

import co.novu.common.base.Novu;
import co.novu.api.subscribers.requests.UpdateSubscriberPreferenceRequest;
import co.novu.api.subscribers.responses.SingleSubscriberPrefResponse;

public class Main {
public static void main(String[] args) {
String apiKey = "<NOVU_SECRET_KEY>";
Novu novu = new Novu(apiKey);
String subscriberId = "<SUBSCRIBER_ID>";
String templateId = "<TEMPLATE_ID>";

        PreferenceChannel channel = new PreferenceChannel();
        channel.setType("<TYPE>");
        channel.setEnabled(true);

        UpdateSubscriberPreferenceRequest request = new UpdateSubscriberPreferenceRequest();
        request.setEnabled(false);
        request.setChannel(channel);

        SingleSubscriberPrefResponse response = novu.updateSubscriberPreferences(request, subscriberId, templateId);
    }

}

Response

{
  "data": {
    "preference": {
      "channels": {
        "chat": "boolean",
        "email": "boolean",
        "in_app": "boolean",
        "push": "boolean",
        "sms": "boolean"
      },
      "enabled": "boolean"
    },
    "template": {
      "_id": "string",
      "critical": "boolean",
      "name": "string"
    }
  }
}

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

The subscriber preferences for every ChannelTypeEnum for the workflow assigned.

Show child attributes

channel.type

enum<string>

required

The type of channel that is enabled or not

Available options:

in_app,

email,

sms,

chat,

push

channel.enabled

boolean

required

If channel is enabled or not

enabled

boolean

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

Response

200

application/json

OK

data

object

Show child attributes

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.name

string

required

Name 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.triggers

string[]

required

Triggers are the events that will trigger the workflow.

data.preference

object

required

The preferences of the subscriber regarding the related workflow

Show child attributes

data.preference.enabled

boolean

required

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

data.preference.channels

object

required

Subscriber preferences for the different channels regarding this workflow

Show child attributes

data.preference.channels.email

boolean

data.preference.channels.sms

boolean

data.preference.channels.in_app

boolean

data.preference.channels.chat

boolean

data.preference.channels.push

boolean