README.md

Properties

(subscribers.properties)

Overview

Available Operations

• updateOnlineFlag - Update subscriber online status

updateOnlineFlag

Used to update the subscriber isOnline flag.

Example Usage

import { Novu } from "@novu/api";

const novu = new Novu({
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const result = await novu.subscribers.properties.updateOnlineFlag("<value>", {
    isOnline: false,
  });
  
  // Handle the result
  console.log(result)
}

run();

Standalone function

The standalone function version of this method:

import { NovuCore } from "@novu/api/core.js";
import { subscribersPropertiesUpdateOnlineFlag } from "@novu/api/funcs/subscribersPropertiesUpdateOnlineFlag.js";

// Use `NovuCore` for best tree-shaking performance.
// You can create one instance of it to use across an application.
const novu = new NovuCore({
  apiKey: "<YOUR_API_KEY_HERE>",
});

async function run() {
  const res = await subscribersPropertiesUpdateOnlineFlag(novu, "<value>", {
    isOnline: false,
  });

  if (!res.ok) {
    throw res.error;
  }

  const { value: result } = res;

  // Handle the result
  console.log(result)
}

run();

Parameters

Parameter	Type	Required	Description
subscriberId	string	✔️	N/A
updateSubscriberOnlineFlagRequestDto	components.UpdateSubscriberOnlineFlagRequestDto	✔️	N/A
options	RequestOptions	➖	Used to set various options for making HTTP requests.
options.fetchOptions	RequestInit	➖	Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All Request options, except method and body, are allowed.
options.retries	RetryConfig	➖	Enables retrying HTTP requests under certain failure conditions.

Response

Promise<components.SubscriberResponseDto>

Errors

Error Object	Status Code	Content Type
errors.SDKError	4xx-5xx	/