DELETE
/
v2
/
subscribers
/
{subscriberId}
import { Novu } from "@novu/api";

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

async function run() {
  const result = await novu.subscribers.delete("<id>");

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

run();
{
  "acknowledged": true,
  "status": "success"
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
idempotency-key
string

A header for idempotency purposes

Path Parameters

​
subscriberId
string
required

Response

200
application/json
OK
​
acknowledged
boolean
required

Indicates whether the operation was acknowledged by the server

Example:

true

​
status
string
required

Status of the subscriber removal operation

Example:

"success"

Was this page helpful?

Suggest editsRaise issue