Delete a message

Delete a message entity from the Novu platform by messageId. This action is irreversible. messageId is required and of mongodbId type.

Authorization

Authorization<token>

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

In: header

Path Parameters

messageIdRequiredstring

Header Parameters

idempotency-keystring

A header for idempotency purposes

Response Body

acknowledgedRequiredboolean

A boolean stating the success of the action

statusRequiredstring

The status enum for the performed action

Value in: "deleted"

export interface Response {
  /**
   * A boolean stating the success of the action
   */
  acknowledged: boolean;
  /**
   * The status enum for the performed action
   */
  status: "deleted";
}

curl -X DELETE "https://api.novu.co/v1/messages/507f1f77bcf86cd799439011" \
  -H "idempotency-key: string" \
  -H "Authorization: <token>"

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

Authorization

Path Parameters

Header Parameters

Response Body

On this page