Get subscriber preferences

GET

subscribers

{subscriberId}

preferences

import co.novu.common.base.Novu;
import co.novu.api.subscribers.responses.SubscriberPreferenceResponse;

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

        SubscriberPreferenceResponse response = novu.getSubscriberPreferences(subscriberId);
    }

}

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

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

E.g ApiKey 18d2e625f05d80e

import co.novu.common.base.Novu;
import co.novu.api.subscribers.responses.SubscriberPreferenceResponse;

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

        SubscriberPreferenceResponse response = novu.getSubscriberPreferences(subscriberId);
    }

}

{
  "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

headerrequired

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

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

data

object[]

Was this page helpful?

Update subscriber online status Get subscriber preferences by level

import co.novu.common.base.Novu;
import co.novu.api.subscribers.responses.SubscriberPreferenceResponse;

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

        SubscriberPreferenceResponse response = novu.getSubscriberPreferences(subscriberId);
    }

}

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