- API Reference
- Discord Support
- 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 preference
- 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
- GETFilter topics
- POSTTopic creation
- POSTSubscribers addition
- GETCheck topic subscriber
- POSTSubscribers removal
- GETGet topic
- DELDelete topic
- PATCHRename a topic
- GETGet notifications
- GETGet notification statistics
- GETGet notification graph statistics
- GETGet notification
- GETGet workflows
- POSTCreate workflow
- GETGet workflow
- PUTUpdate workflow
- DELDelete workflow
- PUTUpdate workflow status
- POSTCreate workflow overrides
- GETGet workflow overrides
- GETGet workflow override
- GETGet workflow override by id
- PUTUpdate workflow override by id
- PUTUpdate workflow override
- DELDelete workflow override
- GETGet workflow groups
- POSTCreate workflow group
- GETGet workflow group
- DELDelete workflow group
- PATCHUpdate workflow group
- GETGet integrations
- POSTCreate integration
- GETGet active integrations
- GETGet webhook support status for provider
- PUTUpdate integration
- DELDelete integration
- POSTSet integration as primary
- GETFilter layouts
- POSTLayout creation
- GETGet layout
- DELDelete layout
- PATCHUpdate a layout
- POSTSet default layout
- GETGet execution details
Subscribers
Topics
Notification
Workflows
Workflow Overrides
Workflow groups
Integrations
Layouts
Execution Details
Update a layout
User defined custom name and provided by the user that will name the Layout updated.
User defined custom key that will be a unique identifier for the Layout updated.
User defined description of the layout
User defined content for the layout.
User defined variables to render in the layout placeholders.
Variable that defines if the layout is chosen as default when creating a layout.
import { Novu } from '@novu/node';
const novu = new Novu('<NOVU_API_KEY>');
const payloadToUpdate = {
content: "<h1>Layout Start</h1>{{{body}}}<h1>Layout End</h1>",
description: "Organisation's first layout",
name: "First Layout",
identifier: "firstlayout",
variables: [
{
type: "String",
name: "body"
required: true
defValue: ""
}
]
isDefault: false
}
await novu.layouts.update("layoutId", payloadToUpdate);
{
"name": "string",
"identifier": "string",
"description": "string",
"content": "string",
"variables": [
{}
],
"isDefault": true
}
Enter your API key in the Authorization
field like the example shown below:
E.g ApiKey 18d2e625f05d80e
Path Parameters
Body
User defined custom name and provided by the user that will name the Layout updated.
User defined custom key that will be a unique identifier for the Layout updated.
User defined description of the layout
User defined content for the layout.
User defined variables to render in the layout placeholders.
Variable that defines if the layout is chosen as default when creating a layout.
Response
in_app
, email
, sms
, chat
, push
Was this page helpful?
import { Novu } from '@novu/node';
const novu = new Novu('<NOVU_API_KEY>');
const payloadToUpdate = {
content: "<h1>Layout Start</h1>{{{body}}}<h1>Layout End</h1>",
description: "Organisation's first layout",
name: "First Layout",
identifier: "firstlayout",
variables: [
{
type: "String",
name: "body"
required: true
defValue: ""
}
]
isDefault: false
}
await novu.layouts.update("layoutId", payloadToUpdate);
{
"name": "string",
"identifier": "string",
"description": "string",
"content": "string",
"variables": [
{}
],
"isDefault": true
}