Sign in

v1

latestOpenAPI 3.0.32026-07-13218142597.2 KB
Page

Create page

Creates a page in the space.

Pages are created as published by default unless specified as a draft in the status field. If creating a published page, the title must be specified.

Permissions required: Permission to view the corresponding space. Permission to create a page in the space.

post/pages

Query parameters

embeddedboolean

Tag the content as embedded and content will be created in NCS.

privateboolean

The page will be private. Only the user who creates this page will have permission to view and edit one.

root-levelboolean

The page will be created at the root level of the space (outside the space homepage tree). If true, then a value may not be supplied for the parentId body parameter.

Request body

spaceIdstring required

ID of the space.

status'current' | 'draft'

The status of the page, published or draft.

titlestring

Title of the page, required if page status is not draft.

parentIdstring

The parent content ID of the page. If the root-level query parameter is set to false and a value is not supplied for this parameter, then the space homepage's ID will be used. If the root-level query parameter is set to true, then a value may not be supplied for this parameter.

subtype'live'

The subtype of the page. Provide the subtype live to create a live doc or no subtype to create a page.

Response

Returned if the page was successfully created.

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.