subscriberscontrollergetsubscriberpreferencebylevelrequest.md

SubscribersControllerGetSubscriberPreferenceByLevelRequest

Example Usage

import { SubscribersControllerGetSubscriberPreferenceByLevelRequest } from "@novu/api/models/operations";

let value: SubscribersControllerGetSubscriberPreferenceByLevelRequest = {
  preferenceLevel: "global",
  subscriberId: "<id>",
};

Fields

Field	Type	Required	Description
includeInactiveChannels	boolean	➖	A flag which specifies if the inactive workflow channels should be included in the retrieved preferences. Default is true
preferenceLevel	operations.Parameter	✔️	the preferences level to be retrieved (template / global)
subscriberId	string	✔️	N/A
idempotencyKey	string	➖	A header for idempotency purposes