# 创建清单

创建一个清单。清单可以用于组织和管理属于同一个项目的多个任务。

创建时，必须填写清单的名字。同时，可以设置通过`members`字段设置清单的协作成员。关于member的格式，详见[功能概述](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/overview)中的“ 如何表示任务和清单的成员？”章节。

创建清单后，创建人自动成为清单的所有者。如果请求同时将创建人设置为可编辑/可阅读角色，则最终该用户成为清单所有者，并自动从清单成员列表中消失。因为同一个用户在同一个清单只能拥有一个角色。

## 请求

基本 | &nbsp;
---|---
HTTP URL | https://open.feishu.cn/open-apis/task/v2/tasklists
HTTP Method | POST
接口频率限制 | [1000 次/分钟、50 次/秒](https://open.feishu.cn/document/ukTMukTMukTM/uUzN04SN3QjL1cDN)
支持的应用类型 | Custom App、Store App
权限要求<br>**调用该 API 所需的权限。开启其中任意一项权限即可调用** | 查看、创建、更新、删除任务清单(task:tasklist:write)

### 请求头

名称 | 类型 | 必填 | 描述
---|---|---|---
Authorization | string | 是 | `tenant_access_token`<br>或<br>`user_access_token`<br>**值格式**："Bearer `access_token`"<br>**示例值**："Bearer u-7f1bcd13fc57d46bac21793a18e560"<br>[了解更多：如何选择与获取 access token](https://open.feishu.cn/document/uAjLw4CM/ugTN1YjL4UTN24CO1UjN/trouble-shooting/how-to-choose-which-type-of-token-to-use)
Content-Type | string | 是 | **固定值**："application/json; charset=utf-8"

### 查询参数

名称 | 类型 | 必填 | 描述
---|---|---|---
user_id_type | string | 否 | 用户 ID 类型<br>**示例值**：open_id<br>**默认值**：`open_id`

### 请求体

名称 | 类型 | 必填 | 描述
---|---|---|---
name | string | 是 | 清单名称，必填。最多100个字符。<br>**示例值**："年会工作任务清单"
members | member\[\] | 否 | 清单的成员列表。关于member的格式，详见[功能概述](https://open.feishu.cn/document/uAjLw4CM/ukTMukTMukTM/task-v2/overview)中的“ 如何表示任务和清单的成员？”章节。<br>**数据校验规则**：<br>- 最大长度：`500`
id | string | 否 | 表示member的id<br>**示例值**："ou_2cefb2f014f8d0c6c2d2eb7bafb0e54f"<br>**数据校验规则**：<br>- 最大长度：`100` 字符
type | string | 否 | 成员的类型，支持:<br>- user：普通用户，此时member的id是一个表示用户的ID，比如open_id。具体格式取决于user_id_type参数<br>- chat：群组，此时member的id是一个Open Chat ID<br>- app：应用，此时member的id是一个应用的ID<br>**示例值**："user"<br>**默认值**：`user`
role | string | 否 | 成员角色，可以是"editor"(可编辑）或者"viewer"（可阅读）。默认为"viewer"。<br>**示例值**："editor"<br>**数据校验规则**：<br>- 最大长度：`20` 字符

### 请求体示例
```json
{
    "name": "年会工作任务清单",
    "members": [
        {
            "id": "ou_2cefb2f014f8d0c6c2d2eb7bafb0e54f",
            "type": "user",
            "role": "editor"
        }
    ]
}
```

## 响应

### 响应体

名称 | 类型 | 描述
---|---|---
code | int | 错误码，非 0 表示失败
msg | string | 错误描述
data | \- | \-
tasklist | tasklist | 创建的清单数据
guid | string | 清单的全局唯一ID
name | string | 清单名
creator | member | 清单创建者
id | string | 表示member的id
type | string | 成员的类型
role | string | 成员角色
owner | member | 清单所有者
id | string | 表示member的id
type | string | 成员的类型
role | string | 成员角色
members | member\[\] | 清单成员
id | string | 表示member的id
type | string | 成员的类型
role | string | 成员角色
url | string | 该清单分享的applink
created_at | string | 清单创建时间戳(ms)
updated_at | string | 清单最后一次更新时间戳（ms)

### 响应体示例
```json
{
    "code": 0,
    "msg": "success",
    "data": {
        "tasklist": {
            "guid": "cc371766-6584-cf50-a222-c22cd9055004",
            "name": "年会总结工作任务清单",
            "creator": {
                "id": "ou_2cefb2f014f8d0c6c2d2eb7bafb0e54f",
                "type": "user",
                "role": "editor"
            },
            "owner": {
                "id": "ou_2cefb2f014f8d0c6c2d2eb7bafb0e54f",
                "type": "user",
                "role": "owner"
            },
            "members": [
                {
                    "id": "ou_2cefb2f014f8d0c6c2d2eb7bafb0e54f",
                    "type": "user",
                    "role": "editor"
                }
            ],
            "url": "https://applink.feishu.cn/client/todo/task_list?guid=b45b360f-1961-4058-b338-7f50c96e1b52",
            "created_at": "1675742789470",
            "updated_at": "1675742789470"
        }
    }
}
```

### 错误码

HTTP状态码 | 错误码 | 描述 | 排查建议
---|---|---|---
400 | 1470400 | 请求参数错误，例如没有填写清单名字。 | 错误原因见返回的msg提示的信息。
500 | 1470500 | 服务器错误。 | 尝试重试调用。如持续失败，请联系支持人员进行反馈。

