端点

/api/riff/renameRiffDeck

重命名闪卡包 (renameRiffDeck)

首页 | Riff API | GitHub Source

功能描述

此 API 端点 POST /api/riff/renameRiffDeck 用于重命名指定的闪卡包 (Deck)。

请求参数

请求体必须是 JSON 格式，包含以下参数：

• deckID (string): 必填。要重命名的闪卡包的 ID。
• name (string): 必填。新的闪卡包名称。名称不能为空，且不能与其他现有的闪卡包名称重复。

请求示例:

{
  "deckID": "20231027111111-abcdefg",
  "name": "我的学习卡包"
}

响应结果

成功的请求将返回一个 JSON 对象，code 为 0，data 为 null。

{
  "code": 0,
  "msg": "",
  "data": null
}

如果操作失败（例如卡包 ID 不存在、新名称无效或与其他卡包重名），将返回非 0 的 code 和具体的错误信息 msg。

{
  "code": -1,
  "msg": "闪卡包 [新名称] 已存在", // 示例错误信息
  "data": null
}

在线测试

您可以在下方输入要重命名的闪卡包 ID 和新的名称进行在线测试。

API Token:
Endpoint:
Method:
Parameters (JSON):

发送请求

响应结果:

思源笔记 API 文档 | 最后更新时间：