NOnovu
Layouts

Update a layout

Changed on

Updates the details of an existing layout, here layoutId is the identifier of the layout

put/v2/layouts/{layoutId}

Request

  • Base URL
    https://api.novu.co
  • Auth
    API key in header Authorization

Path parameters

layoutIdstring required

Headers

idempotency-keystring

A header for idempotency purposes

Request body

namestring required

Name of the layout

isTranslationEnabledboolean

Enable or disable translations for this layout

Response

OK

_idstring required

Unique internal identifier of the layout

layoutIdstring required

Unique identifier for the layout

slugstring required

Slug of the layout

namestring required

Name of the layout

isDefaultboolean required

Whether the layout is the default layout

isTranslationEnabledboolean required

Whether the layout translations are enabled

updatedAtstring required

Last updated timestamp

createdAtstring required

Creation timestamp

origin'novu-cloud' | 'novu-cloud-v1' | 'external' required

Origin of the workflow

type'REGULAR' | 'ECHO' | 'BRIDGE' required

Type of the layout

variablesobject nullable

The variables JSON Schema for the layout

Changes

  • a5b639d63138Revision changes
    • breaking

      the request property type changed from no type to object

    • breaking

      the response's property type changed from no type to object for status

  • f056922796adRevision changes
    • breaking

      the response property ///// became optional for the status

    • breaking

      the ///// response's property type changed from no type to object for status

    • info

      removed from the ///// response property allOf list for the response status