Skip to content

更新工单自定义字段

该接口用于更新自定义字段。

Tip: 注意事项: user_access_token 访问,需要操作者是当前服务台的管理员或所有者

请求

项目
HTTP URLhttps://open.feishu.cn/open-apis/helpdesk/v1/ticket_customized_fields/:ticket_customized_field_id
HTTP MethodPATCH
支持的应用类型custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用helpdesk:all 更新服务台资源详情

请求头

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

Tip: 服务台请求Header中还需添加“服务台token”参数:

Key: X-Lark-Helpdesk-Authorization

Value: base64(helpdesk_id:helpdesk_token),通过base64加密将helpdesk_id和helpdesk_token用':'连接而成的字符串。

了解更多:获取与使用服务台token

路径参数

名称类型描述
ticket_customized_field_idstring工单自定义字段ID 示例值:"6948728206392295444"

请求体

引用类型: ticket_customized_field

名称类型必填描述
display_namestring名称 示例值:"test dropdown"
positionstring字段在列表后台管理列表中的位置 示例值:"3"
descriptionstring描述 示例值:"下拉示例"
visibleboolean是否可见 示例值:true
requiredboolean是否必填 示例值:false
dropdown_optionsdropdown_option下拉列表选项
∟ childrendropdown_option[]选项列表
∟ tagstring选项ID
∟ display_namestring展示名称
∟ childrendropdown_option[]同上:选项列表,只适用于多层下拉列表(最多可以设置三级下拉列表)

请求体示例

json
{
    "display_name": "test dropdown",
    "position": "3",
    "description": "下拉示例",
    "visible": true,
    "required": false
}

响应

响应体

名称类型描述
codeint错误码,非 0 表示失败
msgstring错误描述

响应体示例

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

错误码

HTTP状态码错误码描述排查建议
400154000Bad request, please check your request body请求不合法,请检查参数
401154001Unauthorized, please check you have the correct access检查Authorization 和 X-Lark-Helpdesk-Authorization 是否正确,应用和服务台属于同一租户
403154003Please check you have the correct access检查是否申请正确权限
500155000Internal error内部错误,请联系我们

内容来源:飞书开放平台 · 自动爬取整理