PATCH
/
v1
/
layouts
/
{layoutId}
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

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
}

Authorizations

​
Authorization
string
header
required

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

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
​
_organizationId
string
required
​
_environmentId
string
required
​
_creatorId
string
required
​
name
string
required
​
identifier
string
required
​
channel
enum<string>
required
Available options:
in_app,
email,
sms,
chat,
push
​
content
string
required
​
contentType
string
required
​
isDefault
boolean
required
​
isDeleted
boolean
required
​
_id
string
​
description
string
​
variables
object[]
​
createdAt
string
​
updatedAt
string
​
_parentId
string

Was this page helpful?