API Reference
Subscribers
- GETGet subscribers
- POSTCreate subscriber
- POSTBulk create subscribers
- GETGet subscriber
- PUTUpdate subscriber
- DELDelete subscriber
- PUTUpdate provider credentials
- DELDelete provider credentials
- PATCHUpdate subscriber online status
- GETGet subscriber preferences
- GETGet subscriber global preferences
- PATCHUpdate subscriber preference
- PATCHUpdate subscriber global preferences
- GETRetrieve subscriber notifications
- GETRetrieve unseen notifications count
- POSTMark a subscriber feed message as seen
- POSTUpdate all notifications state
- POSTUpdate notification action status
- GETHandle providers oauth redirect
- GETHandle chat oauth
Topics
Notification
Workflows
Workflow Overrides
Workflow groups
Integrations
Layouts
Execution Details
Organizations
Layouts
Set default layout
Sets the default layout for the environment and updates to non default to the existing default layout (if any).
POST
/
v1
/
layouts
/
{layoutId}
/
default
import { Novu } from '@novu/node';
const novu = new Novu('<NOVU_API_KEY>');
await novu.layouts.setDefault("layoutId");
{
204: "The selected layout has been set as the default for the environment."
404: "The layout with the layoutId provided does not exist in the database so it can not be set as the default for 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.setDefault("layoutId");
{
204: "The selected layout has been set as the default for the environment."
404: "The layout with the layoutId provided does not exist in the database so it can not be set as the default for the environment."
}
Authorizations
API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".
Path Parameters
Response
204
The selected layout has been set as the default for the environment.
Was this page helpful?
import { Novu } from '@novu/node';
const novu = new Novu('<NOVU_API_KEY>');
await novu.layouts.setDefault("layoutId");
{
204: "The selected layout has been set as the default for the environment."
404: "The layout with the layoutId provided does not exist in the database so it can not be set as the default for the environment."
}
Assistant
Responses are generated using AI and may contain mistakes.