API reference
Help centerCommunityDevelopersAcademyStatus

Create new layouts.

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

Use the /layouts end-point to create a new layout.
User roles: admin, manager

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

Contains the layout to create.

A new 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:
date-time

Optional creation date of this layout in ISO 8601 with the format YYYY-MM-DDThh:mm:ss.sssZ. Value is ignored if set in the future.

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

409

Layout with the same path exists.

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