Sign in

v1

latestOpenAPI 3.0.02026-07-2417611.8 MB
Authoring sites

Update a page.

Updates the page metadata specified by page-id in the site specified by site-id. Move of a page to a different parent or repositioning with other sibling pages is not supported, use the move endpoint instead. The full page metadata must be supplied, partial updates are not supported. <br />User roles: admin, manager, editor

put/authoring/v1/sites/{site-id}/pages/{page-id}

Path parameters

site-idstring uuid required

The ID of the site.

page-idstring uuid required

ID of page.

Query parameters

forceOverrideboolean

Force update of the existing page metadata without requiring the current rev value. When set to true this request will overwrite the stored page metadata regardless of a difference in revisions.

Request body

namestring

The name of the page.

idstring

The ID of the page item.

revstring

(Optional) The revision of the document.

positionstring

The position of the page relative to its sibling pages. Position is an integer value starting at 0.

descriptionstring

Page description.

layoutIdstring

Page layout template ID.

contentIdstring

The ID of the page content item this item represents.

contentTypeIdstring

The ID of the page content type.

segmentstring

Friendly URL segment.

titlestring

Page title.

parentIdstring

(Optional) The ID of the parent page. This should not be set if the new page is to be a root page. Otherwise, set this field to the ID of the parent page.

classificationstring

this is always page

hideFromNavigationboolean

(Optional) This controls the visibility of the page in the site navigation menu. Set it to true to hide the page. The default setting (if this field is not supplied) is false. If to true set on a parent page, it will override the corresponding flags in all descendant pages. Therefore, hiding a page will hide all its descendants in the site navigation menu.

Response

Page successfully updated.

idstring

The ID of the page item.

revstring

The current revision of the document.

namestring

The name of the page item.

contentIdstring

The ID of the page content item this item represents.

contentTypeIdstring

The ID of the page content type.

positionstring

Position relative to sibling pages giving the order of the pages. Position is an integer value starting at 0.

descriptionstring

Page description.

layoutIdstring

Page layout template ID.

segmentstring

Friendly URL segment.

titlestring

Page title.

parentIdstring

Not present if root page otherwise id of parent page

classificationstring

This is always page

lastModifiedstring

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

lastModifierIdstring

This is the user id of the user that modified the page. This field is read only

createdstring

The creation date of this page in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ. This field is read only

creatorIdstring

This is the user id of the user that created the page. This field is read only.

hideFromNavigationboolean

This controls the visibility of the page in the site navigation menu. If set to true this page is hidden. If set to true on a parent page, it will override the corresponding flags in all descendant pages. Therefore, hiding a page will hide all its descendants in the site navigation menu.