Delete a subscriber | Novu Documentation

Deletes a subscriber entity from the Novu platform along with associated messages, preferences, and topic subscriptions. subscriberId is a required field.

Authorization

Authorization<token>

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

In: header

Path Parameters

subscriberIdRequiredstring

Header Parameters

idempotency-keystring

A header for idempotency purposes

Response Body

acknowledgedRequiredboolean

Indicates whether the operation was acknowledged by the server

statusRequiredstring

Status of the subscriber removal operation

export interface Response {
  /**
   * Indicates whether the operation was acknowledged by the server
   */
  acknowledged: boolean;
  /**
   * Status of the subscriber removal operation
   */
  status: string;
}

curl -X DELETE "https://api.novu.co/v2/subscribers/string" \
  -H "idempotency-key: string" \
  -H "Authorization: <token>"

{
  "acknowledged": true,
  "status": "success"
}