Sign in
Pages

Create a page

Create a new page in a doc. Note that creating a page requires you to be a Doc Maker in the applicable workspace.

post/docs/{docId}/pages

Request

  • Base URL: https://docs.superhuman.com/apis/v1
  • URL: https://docs.superhuman.com/apis/v1/docs/{docId}/pages
  • Auth: HTTP bearer

Path parameters

docIdstring required

ID of the doc.

Request body

namestring

Name of the page.

subtitlestring

Subtitle of the page.

iconNamestring

Name of the icon.

imageUrlstring

Url of the cover image to use.

parentPageIdstring

The ID of this new page's parent, if creating a subpage.

Example request

{
  "name": "Launch Status",
  "subtitle": "See the status of launch-related tasks.",
  "iconName": "rocket",
  "imageUrl": "https://example.com/image.jpg",
  "parentPageId": "canvas-tuVwxYz",
  "pageContent": {
    "canvasContent": {
      "content": "<p><b>This</b> is rich text</p>"
    }
  }
}

Response

A result indicating that the creation request was queued for processing.

requestIdstring required

An arbitrary unique identifier for this request.

idstring required

ID of the created page.

Example response

{
  "requestId": "abc-123-def-456",
  "id": "canvas-tuVwxYz"
}

Changes

No recorded changes to this operation across all 1 revision of this API.