Layouts
Update a layout
Layouts
Update a layout
Update the name, content and variables of a layout. Also change it to be default or no.
PATCH
/v1/layouts/{layoutId}
Authorization*
Please ensure there is a space between ApiKey and your Api key.
E.g ApiKey 18d2e625f05d80e
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);
{
data: data
}
Path Parameters
layoutIdrequired
string
Body
application/json
content
string
User defined content for the layout.
description
string
User defined description of the layout
identifierrequired
string
User defined custom key that will be a unique identifier for the Layout updated.
isDefault
boolean
Variable that defines if the layout is chosen as default when creating a layout.
name
string
User defined custom name and provided by the user that will name the Layout updated.
variables
object[]
User defined variables to render in the layout placeholders.
Response
200 - application/json
data
object
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);
{
data: data
}