DELETE
/
v1
/
messages
/
{messageId}
import { Novu } from "@novu/api";

const novu = new Novu({
  secretKey: "YOUR_SECRET_KEY_HERE",
});

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

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

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

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

​
messageId
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

Was this page helpful?

Suggest editsRaise issue
Get messagesDelete messages by transactionId