笔记编辑

POST

/api/open/api/v1/note/edit

限频：1

每个用户/每个API/每秒钟内请求 1 次，超出频率的请求会被拦截掉

配额：1000 次/天

调用成功才计为 1 次，即：每天可以基于 API 编辑 1000 次

限制

只有基于 API 创建的笔记，才能基于 API 做后续的编辑。即：目前暂不支持使用 API 编辑小程序端创建的笔记

请求参数

Header 参数

Body 参数application/json

示例

{
    "noteId": "string",
    "body": {
        "type": "string",
        "text": "string",
        "content": [
            {}
        ],
        "marks": [
            {}
        ],
        "attrs": {
            "property1": "string",
            "property2": "string"
        }
    }
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST '/api/open/api/v1/note/edit' \
--header 'Authorization: Bearer {{API-KEY}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "noteId": "string",
    "body": {
        "type": "string",
        "text": "string",
        "content": [
            {}
        ],
        "marks": [
            {}
        ],
        "attrs": {
            "property1": "string",
            "property2": "string"
        }
    }
}'

返回响应

🟢200成功

application/json

Body

示例

{
    "noteId": "string"
}

🔴500服务器错误

修改于 2025-06-09 10:11:42

笔记创建

笔记设置