API reference
Help centerCommunityDevelopersAcademyStatus
Start typing to search…

Update a page.

put
https://example.com/authoring/v1/sites//pages/

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.

User roles: admin, manager, editor

Path Params
uuid
required

The ID of the site.

uuid
required

ID of page.

Query Params
boolean

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.

Body Params

The metadata for the updated page.

string

The name of the page.

string

The ID of the page item.

string

(Optional) The revision of the document.

string

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

string

Page description.

string

Page layout template ID.

string

The ID of the page content item this item represents.

string

The ID of the page content type.

string

Friendly URL segment.

string

Page title.

string

(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.

string

this is always page

boolean

(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.

Responses

Updated about 22 hours ago

Language
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated about 22 hours ago