API reference
Help centerCommunityDevelopersAcademyStatus

Update an existing layout.

put
https://example.com/authoring/v1/layouts/

Use the /layouts/{id} end-point to update an existing layout within the database.
User roles: admin, manager

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The ID of the layout document to update.

Query Params
boolean
Defaults to false

Specifies whether revision checking should be disabled.

Body Params

Contains the updated layout object to save.

An existing layout.

string
length ≥ 1

The ID of the layout.

string
required
length ≥ 1

The current revision of the layout.

string
required
length ≥ 1

The name of the layout.

string

The description of the layout.

string
enum

Indicates the type of this document.

Allowed:
string

The ID of the user that created the layout.

string

The display name of the user that created the layout. This field is only returned when the 'include' query string option is set to 'ALL' or 'metadata'.
This field is read only.

date-time

The created date of this layout in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.

string

The ID of the user that last modified the layout.

string

The display name of the last user that modified the layout. This field is only returned when the 'include' query string option is set to 'ALL' or 'metadata'.
This field is read only.

date-time

The last modified date of this layout in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. This field is read only.

string

Optional path to associate with the layout. Must be unique. Will default to filesystem friendly version of /[NAME].

boolean
Defaults to false

Indicates if the layout should be prerendered.

tags
array of strings
tags
thumbnail
object

The reference to the asset that should act as the thumbnail of this layout.
The thumbnail can be referred to by either id or path.

string
required
length ≥ 1
string
enum
Defaults to handlebars

Specifies the type of template associated with this layout. This field is required when prerender field is set to true.

Allowed:
string

Specifies the pattern for url generation.

boolean
Defaults to false

Indicates whether this item is a 'system item' or not.

Responses

Updated 3 months ago

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 3 months ago