import { Novu, ChannelTypeEnum } from '@novu/node';
const novu = new Novu('<NOVU_API_KEY>');
await novu.messages.deleteById("<Message_Id>");
use Novu\SDK\Novu;
$novu = new Novu("<NOVU_API_KEY>");
$novu->deleteMessage();
require 'novu'
client = Novu::Client.new('<NOVU_API_KEY>')
client.delete_message('<insert-message-id>')
from novu.api import MessageApi
url = "https://api.novu.co"
api_key = "<NOVU_API_KEY>"
novu = MessageApi(url, api_key).delete(
message_id= "The message ID to delete",
)
import co.novu.sdk.Novu;
public class Main {
public static void main(String[] args) {
String apiKey = "<NOVU_API_KEY>";
Novu novu = new Novu(apiKey);
novu.deleteMessage(messageId);
}
}
{
"data": {
"acknowledged": true,
"status": "deleted"
}
}
Messages
Delete a message
Delete a message entity from the Novu platform by messageId. This action is irreversible. messageId is required and of mongodbId type.
DELETE
/
v1
/
messages
/
{messageId}
import { Novu, ChannelTypeEnum } from '@novu/node';
const novu = new Novu('<NOVU_API_KEY>');
await novu.messages.deleteById("<Message_Id>");
use Novu\SDK\Novu;
$novu = new Novu("<NOVU_API_KEY>");
$novu->deleteMessage();
require 'novu'
client = Novu::Client.new('<NOVU_API_KEY>')
client.delete_message('<insert-message-id>')
from novu.api import MessageApi
url = "https://api.novu.co"
api_key = "<NOVU_API_KEY>"
novu = MessageApi(url, api_key).delete(
message_id= "The message ID to delete",
)
import co.novu.sdk.Novu;
public class Main {
public static void main(String[] args) {
String apiKey = "<NOVU_API_KEY>";
Novu novu = new Novu(apiKey);
novu.deleteMessage(messageId);
}
}
{
"data": {
"acknowledged": true,
"status": "deleted"
}
}
Enter your API key in the
Authorization field like the example shown below:E.g ApiKey 18d2e625f05d80eimport { Novu, ChannelTypeEnum } from '@novu/node';
const novu = new Novu('<NOVU_API_KEY>');
await novu.messages.deleteById("<Message_Id>");
use Novu\SDK\Novu;
$novu = new Novu("<NOVU_API_KEY>");
$novu->deleteMessage();
require 'novu'
client = Novu::Client.new('<NOVU_API_KEY>')
client.delete_message('<insert-message-id>')
from novu.api import MessageApi
url = "https://api.novu.co"
api_key = "<NOVU_API_KEY>"
novu = MessageApi(url, api_key).delete(
message_id= "The message ID to delete",
)
import co.novu.sdk.Novu;
public class Main {
public static void main(String[] args) {
String apiKey = "<NOVU_API_KEY>";
Novu novu = new Novu(apiKey);
novu.deleteMessage(messageId);
}
}
{
"data": {
"acknowledged": true,
"status": "deleted"
}
}
Authorizations
API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".
Path Parameters
Was this page helpful?