返回接口目录
学习计划/BearerWrite

Delete study plan

Delete a study plan and all tasks that belong to it.

Endpoint

POST/api/v1/agent/capabilities/ielts_study_plans_delete

请求参数

字段类型必填说明
planIdstringplanId
reasonstringreason

调用示例

curl -X POST \
  'https://work.ieltsbuddy.igopx.cn/api/v1/agent/capabilities/ielts_study_plans_delete' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer $IELTS_BUDDY_TOKEN' \
  --data '{"planId":"<planId>","reason":"<reason>"}'

请求结构

{
  "type": "object",
  "properties": {
    "planId": {
      "type": "string",
      "minLength": 1
    },
    "reason": {
      "type": "string",
      "minLength": 1
    }
  },
  "required": [
    "planId",
    "reason"
  ],
  "additionalProperties": false
}

统一响应

接口结果位于 data;code 为 0 表示调用成功。

{
  "code": 0,
  "data": {},
  "message": "ok"
}

错误码

40040001请求参数不符合接口契约
40140101缺少或使用了无效的访问令牌
40340301访问令牌不包含接口所需权限
40440401接口或目标资源不存在