跳到主要内容

更新页面

POST 
/wiki/pages/:pageID

更新页面。

content 规则​

对于 refType 为 collaboration 的协同页面：

  • 请求体中的 content 类型是字符串，但字符串内容必须是符合 Wiz 协同文档数据结构的 JSON，不能直接传入普通文本。
  • 文档顶层结构至少包含 blocks、comments 和 meta，例如 {"blocks": [...], "comments": {}, "meta": {}}。Block 和复杂容器的详细规则请参考 文档数据结构。
  • 更新已有页面时，建议先调用获取页面详情接口，解析返回的 content，在原文档对象上修改后再序列化，避免丢失表格单元格、代码块容器、评论等未修改的数据。
  • 调用本接口时，需要将文档对象序列化为字符串，再将该字符串作为请求体的 content 字段。

请求体示例：

{
  "content": "{\"blocks\":[{\"id\":\"A12345678\",\"type\":\"text\",\"text\":[{\"insert\":\"更新后的正文\"}]}],\"comments\":{},\"meta\":{}}"
}

如果 content 中包含资源、附件或卡片，需要先调用相关接口并把返回的资源/附件 ID 或卡片信息写入 content，再调用本接口更新页面。

推荐顺序：

  1. 调用 POST /wiki/pages/{pageID}/resources 上传资源。
  2. 调用 POST /wiki/pages/{pageID}/attachments 上传附件。
  3. 如需卡片，调用 POST /wiki/pages/{pageID}/cards 创建卡片。
  4. 携带最终 content 调用本接口更新页面。

Request​

Path Parameters

    pageID stringrequired

    页面 ID

Query Parameters

    teamID stringrequired

    团队ID

    requestUserID string

    用户 ID，此参数仅在作为 Oauth 机器人调用时才能传递。它用于以指定用户的身份执行操作

Body

required

title 和 content 不能同时为空，至少需要提供一个。

    title string

    页面标题

    content string

    页面内容。协同页面必须传入符合 Wiz 协同文档数据结构的 JSON 字符串，不能直接传入普通文本。文档顶层结构至少包含 blocks、comments 和 meta，详细规则请参考 文档数据结构。

Responses​

成功

Schema

    result string

    本次请求结果,SUCCESS|FAIL

    errorCode string

    本次请求错误码

    errorMsg string

    本次请求错误信息

    errorData object

    本次请求错误元数据

Loading...