Sign in

v1

latestOpenAPI 3.0.32026-07-13218142597.2 KB
Page

Update page

Update a page by id.

When the "current" version is updated, the provided body content is considered as the latest version. This latest body content will be attempted to be merged into the draft version through a content reconciliation algorithm. If two versions are significantly diverged, the latest provided content may entirely override what was previously in the draft.

Permissions required: Permission to view the page and its corresponding space. Permission to update pages in the space.

put/pages/{id}

Path parameters

idinteger required

The ID of the page to be updated. If you don't know the page ID, use Get Pages and filter the results.

Request body

idstring required

Id of the page.

status'current' | 'draft' required

The updated status of the page.

Note, if you change the status of a page from 'current' to 'draft' and it has an existing draft, the existing draft will be deleted in favor of the updated draft. Additionally, this endpoint can be used to restore a 'trashed' or 'deleted' page to 'current' status. For restoration, page contents will not be updated and only the page status will be changed.

titlestring required

Title of the page.

{"stackTrail":"components:requestBodies:PageUpdateRequest:content:application/json:schema:properties:spaceId","oasType":"schema","type":"unknown","description":"ID of the containing space.\n\nThis currently **does not support moving the page to a different space**."}
{"stackTrail":"components:requestBodies:PageUpdateRequest:content:application/json:schema:properties:parentId","oasType":"schema","type":"unknown","description":"ID of the parent content.\n\nThis allows the page to be moved under a different parent within the same space."}
{"stackTrail":"components:requestBodies:PageUpdateRequest:content:application/json:schema:properties:ownerId","oasType":"schema","type":"unknown","description":"Account ID of the page owner.\n\nThis allows page ownership to be transferred to another user."}

Response

Returned if the requested page is successfully updated.

idstring

ID of the page.

status'current' | 'draft' | 'archived' | 'historical' | 'trashed' | 'deleted' | 'any'

The status of the content.

titlestring

Title of the page.

spaceIdstring

ID of the space the page is in.

parentIdstring

ID of the parent page, or null if there is no parent page.

parentType'page' | 'whiteboard' | 'database' | 'embed' | 'folder'

Content type of the parent, or null if there is no parent.

positioninteger nullable

Position of child page within the given parent page tree.

authorIdstring

The account ID of the user who created this page originally.

ownerIdstring nullable

The account ID of the user who owns this page.

lastOwnerIdstring nullable

The account ID of the user who owned this page previously, or null if there is no previous owner.

createdAtstring date-time

Date and time when the page was created. In format "YYYY-MM-DDTHH:mm:ss.sssZ".

isFavoritedByCurrentUserboolean

Whether the page has been favorited by the current user.