Sign in

v1

latestOpenAPI 3.1.02026-07-24172151607.6 KB
Docs

Create a Page

Create a page in a Doc.

post/api/v3/workspaces/{workspace_id}/docs/{doc_id}/pages

Path parameters

workspace_idnumber required

The ID of the Workspace.

doc_idstring required

The ID of the doc.

Request body

parent_page_idstring

The ID of the parent page. If this is a root page in the Doc, parent_page_id will not be returned.

namestring

The name of the new page.

sub_titlestring

The subtitle of the new page.

contentstring

The content of the new page.

content_format'text/md' | 'text/plain'

The format the page content is in. For example, text/md for markdown or text/plain for plain text.

Response

Page created

idstring required
doc_idstring required
parent_page_idstring
workspace_idnumber required
namestring required
sub_titlestring
date_creatednumber required
date_updatednumber
contentstring required
creator_idnumber required
deletedboolean
deleted_bynumber
date_deletednumber
date_editednumber
edited_bynumber
archivedboolean
archived_bynumber
date_archivednumber
authorsnumber[] required
contributorsnumber[]
protectedboolean
protected_bynumber
protected_notestring