API reference
Help centerCommunityDevelopersAcademyStatus

Update an existing layout mapping.

put
https://example.com/authoring/v1/layout-mappings/

Use the /layout-mappings/{id} end-point to update an existing layout mapping 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 mapping document to update.

Query Params
boolean
Defaults to false

Specifies whether revision checking should be disabled.

Body Params

Contains the updated layout mapping object to save.

An existing layout mapping.

string
length ≥ 1

The ID of the layout mapping.

string
required
length ≥ 1

The current revision of the layout mapping.

string
required
length ≥ 1

The name of the layout mapping.

string
enum

Indicates the type of this document.

Allowed:
string

The ID of the user that created the layout mapping.

string

The display name of the user that created the layout mapping. 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 mapping 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 mapping.

string

The display name of the last user that modified the layout mapping. 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 mapping 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 mapping. Must be unique. Will default to filesystem friendly version of /[NAME].

tags
array of strings
tags
type
object
required

The mapped content-type. Must be unique.
During create and update operations, the mapped content-type can be referred to by either id or name.

mappings
array of objects
required
length between 1 and 1

The mapped layouts.

mappings*

an individual layout mapping entry.
During creates and updates, if there is only one layout specified within the 'layouts' property, then the 'defaultLayout' property is optional (and will be inserted by the system).

defaultLayout
object
required

an individual layout reference.

layouts
array of objects
required
length ≥ 1

The full set of layouts (including the default) associated with this entry. Only layouts specified in this list can be set as a Content override (via the Content.selectedLayouts property)

layouts*

an individual layout reference.

string
required
length ≥ 1

The ID of the referenced layout.

string

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

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