Update a page

Update properties for a page. Note that updating a page title or icon requires you to be a Doc Maker in the applicable workspace.

curl --location --request PUT 'http://dev-cn.your-api-server.com/docs/AbCDeFGH/pages/canvas-IjkLmnO' \ --header 'Content-Type: application/json' \ --data-raw '{ "name": "Launch Status", "subtitle": "See the status of launch-related tasks.", "iconName": "rocket", "imageUrl": "https://example.com/image.jpg", "isHidden": true, "contentUpdate": { "insertionMode": "append", "canvasContent": { "format": "html", "content": "<p><b>This</b> is rich text</p>" } } }'

请求参数

Path 参数

docId

string

必需

ID of the doc.

示例值:

AbCDeFGH

pageIdOrName

string

必需

ID or name of the page. Names are discouraged because they're easily prone to being changed by users. If you're using a name, be sure to URI-encode it. If you provide a name and there are multiple pages with the same name, an arbitrary one will be selected.

示例值:

canvas-IjkLmnO

Body 参数application/json

Payload for updating a page.

name

string

可选

Name of the page.

示例值:

Launch Status

subtitle

string

可选

Subtitle of the page.

示例值:

See the status of launch-related tasks.

iconName

string

可选

Name of the icon.

示例值:

rocket

imageUrl

string

可选

Url of the cover image to use.

示例值:

https://example.com/image.jpg

isHidden

boolean

可选

Whether the page is hidden or not. Note that for pages that cannot be hidden, like the sole top-level page in a doc, this will be ignored.

示例值:

true

contentUpdate

object

可选

Payload for updating the content of an existing page.

insertionMode

enum<string>

PageContentInsertionMode

必需

Mode for inserting content into an existing page.

枚举值:

appendreplace

canvasContent

object

PageContent

必需

Content for a page (canvas).

示例

返回响应

🟢202A result indicating that the update was queued for processing.

application/json

Body

The result of a page update.

requestId

string

必需

An arbitrary unique identifier for this request.

示例值:

abc-123-def-456

string

必需

ID of the updated page.

示例值:

canvas-tuVwxYz

🟠400400

🟠401401

🟠403403

🟠404404

🟠429429