Update a layout

PATCH

layouts

{layoutId}

import { Novu } from '@novu/node';

const novu = new Novu('<NOVU_SECRET_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

import { Novu } from '@novu/node';

const novu = new Novu('<NOVU_SECRET_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
}

Authorizations

Authorization

string

headerrequired

API key authentication. Allowed headers-- "Authorization: ApiKey <api_key>".

Path Parameters

layoutId

string

required

The layout id

Body

application/json

name

string

User defined custom name and provided by the user that will name the Layout updated.

identifier

string

required

User defined custom key that will be a unique identifier for the Layout updated.

description

string

User defined description of the layout

content

string

User defined content for the layout.

variables

object

User defined variables to render in the layout placeholders.

isDefault

boolean

Variable that defines if the layout is chosen as default when creating a layout.

Response

200 - application/json

data

object

Was this page helpful?

Delete layout Set default layout

import { Novu } from '@novu/node';

const novu = new Novu('<NOVU_SECRET_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
}