Layouts
Layout creation
Layouts
Layout creation
Create a layout
POST
/v1/layouts
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 payload = {
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.create(payload);
{
"data": {
"_id": "Layout identifier"
}
}
Body
application/json
contentrequired
string
User defined content for the layout.
description
string
User description of the layout
identifierrequired
string
User defined custom key that will be a unique identifier for the Layout created.
isDefault
boolean
Variable that defines if the layout is chosen as default when creating a layout.
namerequired
string
User defined custom name and provided by the user that will name the Layout created.
variables
object[]
User defined variables to render in the layout placeholders.
Response
201 - application/json
data
object
import { Novu } from '@novu/node';
const novu = new Novu('<NOVU_API_KEY>');
const payload = {
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.create(payload);
{
"data": {
"_id": "Layout identifier"
}
}