DocumentationNovu Documentation
PlatformGuidesFrameworkCommunityAPI Reference
Sign InSign Up

GitHubnovuhq/novu

38.7K

Delete a subscriber

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

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

DELETE
/v2/subscribers/{subscriberId}

Authorization

Authorization<token>

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

In: header

Path Parameters

subscriberIdRequiredstring

Header Parameters

idempotency-keystring

A header for idempotency purposes

Response Body

OK

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"
}

Update a subscriber PATCH

Update a subscriber by its unique key identifier **subscriberId**. **subscriberId** is a required field, rest other fields are optional

Search subscribers GET

Search subscribers by their **email**, **phone**, **subscriberId** and **name**. The search is case sensitive and supports pagination.Checkout all available filters in the query section.

On this page

No Headings
Edit this page on GitHub