Delete layout
API Reference
Subscribers
- GETGet subscribers
- POSTCreate subscriber
- POSTBulk create subscribers
- GETGet subscriber
- PUTUpdate subscriber
- DELDelete subscriber
- PUTUpdate subscriber credentials
- DELDelete subscriber credentials by providerId
- PATCHUpdate subscriber online status
- GETGet subscriber preferences
- GETGet subscriber global preferences
- PATCHUpdate subscriber preference
- PATCHUpdate subscriber global preferences
- GETGet in-app notification feed for a particular subscriber
- GETGet the unseen in-app notifications count for subscribers feed
- POSTMark a subscriber feed message as seen
- POSTMarks all the subscriber messages as read, unread, seen or unseen. Optionally you can pass feed id (or array) to mark messages of a particular feed.
- POSTMark message action as seen
- GETHandle providers oauth redirect
- GETHandle chat oauth
Topics
Notification
Workflows
Workflow Overrides
Workflow groups
Integrations
Layouts
Execution Details
Organizations
Delete layout
Execute a soft delete of a layout given a certain ID.
DELETE
/
v1
/
layouts
/
{layoutId}
import { Novu } from '@novu/node';
const novu = new Novu('<NOVU_API_KEY>');
await novu.layouts.delete("layoutId");
{
204: "The layout has been deleted correctly",
404: "The layout with the layoutId provided does not exist in the database so it can not be deleted.",
409: "Either you are trying to delete a layout that is being used or a layout that is the default in the environment."
}
Enter your API key in the Authorization field like the example shown below:
E.g ApiKey 18d2e625f05d80e
import { Novu } from '@novu/node';
const novu = new Novu('<NOVU_API_KEY>');
await novu.layouts.delete("layoutId");
{
204: "The layout has been deleted correctly",
404: "The layout with the layoutId provided does not exist in the database so it can not be deleted.",
409: "Either you are trying to delete a layout that is being used or a layout that is the default in the environment."
}
Authorizations
API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".
Path Parameters
Was this page helpful?
import { Novu } from '@novu/node';
const novu = new Novu('<NOVU_API_KEY>');
await novu.layouts.delete("layoutId");
{
204: "The layout has been deleted correctly",
404: "The layout with the layoutId provided does not exist in the database so it can not be deleted.",
409: "Either you are trying to delete a layout that is being used or a layout that is the default in the environment."
}