Update a layout

Enter your API key in the Authorization field like the example shown below:

E.g ApiKey 18d2e625f05d80e

Node.js

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);

Response

{
  "name": "string",
  "identifier": "string",
  "description": "string",
  "content": "string",
  "variables": [
    {}
  ],
  "isDefault": true
}

Path Parameters

layoutId

string

required

Body

application/json

identifier

string

required

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

name

string

User defined custom name and provided by the user that will name 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

Ok

data

object

Show child attributes

data._organizationId

string

required

data._environmentId

string

required

data._creatorId

string

required

data.name

string

required

data.identifier

string

required

data.channel

enum<string>

required

Available options:

in_app,

email,

sms,

chat,

push

data.content

string

required

data.contentType

string

required

data.isDefault

boolean

required

data.isDeleted

boolean

required

data._id

string

data.description

string

data.variables

object[]

data.createdAt

string

data.updatedAt

string

data._parentId

string