将自定义字段加入资源

将自定义字段加入一个资源。目前资源类型支持清单tasklist。一个自定义字段可以加入多个清单中。加入后，该清单可以展示任务的该字段的值，同时基于该字段实现筛选，分组等功能。

如果自定义字段的设置被更新，字段加入的所有资源都能收到这个更新，并进行相应的展示。

Tip: 将自定义字段加入一个资源需要该字段和资源的可编辑权限。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/task/v2/custom_fields/:custom_field_guid/add
HTTP Method	POST
接口频率限制	100 次/分钟
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可	task:custom_field:write 查看、创建、更新自定义字段 task:custom_field:writeonly 创建、更新自定义字段

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 或 user_access_token 值格式："Bearer access_token" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token
Content-Type	string	是	固定值："application/json; charset=utf-8"

路径参数

名称	类型	描述
custom_field_guid	string	自定义字段GUID。自定义字段GUID。可以通过创建自定义字段接口创建, 或者通过列取自定义字段接口查询得到。 示例值："0110a4bd-f24b-4a93-8c1a-1732b94f9593"

请求体

名称	类型	必填	描述
resource_type	string	是	要将自定义字段添加到一个资源的资源类型。目前只支持tasklist 示例值："tasklist"
resource_id	string	是	要将自定义字段添加到的资源id，目前只支持tasklist_guid 示例值："0110a4bd-f24b-4a93-8c1a-1732b94f9593"

请求体示例

{
    "resource_type": "tasklist",
    "resource_id": "0110a4bd-f24b-4a93-8c1a-1732b94f9593"
}

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-

响应体示例

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

错误码

HTTP状态码	错误码	描述	排查建议
400	1470400	请求参数错误，如向resource_type传入了不支持的类型。	错误原因见返回的msg提示的信息。
403	1470403	缺少将自定义字段加入到资源的权限。	确认调用身份同时拥有该字段和资源的可编辑权限。
404	1470404	要被添加的自定义字或者要加入的资源不存在或已删除。	确认自定义字段和资源均存在。
500	1470500	服务器错误。	尝试重试调用。如持续失败，请联系支持人员进行反馈。