v1

latestOpenAPI 3.0.02026-07-2417611.8 MB
Authoring sites

Move a page.

Use this endpoint to move a page. The body of the request should be empty. The query parameters should include the 'sourceId', 'sourceRev', 'targetPosition', the optional 'targetId' and 'targetRev'. sourceId and sourceRev relate to the page to be moved. targetId and targetRev relate to the destination parent page. These are optional parameters, if not set it means the source page is to be moved to the site root. The targetPosition field is required, it is an integer value starting at 0. It cannot exceed the number of child pages of the destination parent page. If the move is successful, then the response body JSON object will contain the id and rev of the updated destination parent page (targetId), except in the case of moving to the site root then the response body is an empty JSON object. A refresh of the page hierarchy is recommended after moving a page to a different parent page. <br />User roles: admin, manager, editor

post/authoring/v1/sites/{site-id}/pages/move

Path parameters

site-idstring uuid required

The ID of the site.

Query parameters

sourceIdstring uuid required

The ID of the source page to move.

sourceRevstring required

the 'rev' value for the page to be moved.

targetIdstring uuid

The ID of the target page.

targetRevstring

the 'rev' value for the target page.

targetPositioninteger required

The new position on the target page for the move.

Response

succcess.

idstring

(optional) The ID of the parent page item.

revstring

(optional) The latest revision of the parent page item document.