Delete a message

import { Novu, ChannelTypeEnum } from '@novu/node';

const novu = new Novu('<NOVU_API_KEY>');

await novu.messages.deleteById("<Message_Id>");

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

DELETE

messages

{messageId}

import { Novu, ChannelTypeEnum } from '@novu/node';

const novu = new Novu('<NOVU_API_KEY>');

await novu.messages.deleteById("<Message_Id>");

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

Enter your API key in the Authorization field like the example shown below:E.g ApiKey 18d2e625f05d80e

import { Novu, ChannelTypeEnum } from '@novu/node';

const novu = new Novu('<NOVU_API_KEY>');

await novu.messages.deleteById("<Message_Id>");

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

Authorization

string

header

required

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

messageId

string

required

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