Delete subscriber

Deletes a subscriber entity from the Novu platform

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

E.g ApiKey 18d2e625f05d80e

Node.js

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

const novu = new Novu("<NOVU_SECRET_KEY>");

await novu.subscribers.delete("subscriberId");

Response

{
  "data": {
    "acknowledged": true,
    "status": "deleted"
  }
}

Authorizations

Authorization · string · header · required

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

Path Parameters

subscriberId · string · required

Response

200

application/json

Ok

acknowledged · boolean · required

A boolean stating the success of the action

status · enum<string> · required

The status enum for the performed action

Available options:

deleted