更新用户属性

版本 4.0.23.6（最新）

更新用户属性定义。

请求

PATCH /user_attributes/{user_attribute_id}
数据类型
说明
请求
HTTP 请求
路径
HTTP 路径
展开 HTTPPath 定义...
user_attribute_id
字符串
用户属性的 ID
body
HTTP 正文
展开 HTTPBody 定义...
body
用户特性
展开 UserAttribute 定义...
可以
对象
当前用户可以对此对象执行的操作
id
字符串
唯一 ID
name
字符串
用户属性的名称
标签
字符串
方便用户使用的用户属性标签
类型
字符串
用户属性类型（“字符串”“数字”“日期时间”“是”“邮政编码”）
default_value
字符串
未设置用户时的默认值
is_system
布尔值
属性是系统默认属性
是永久的
布尔值
该属性是永久性的，无法删除
值已隐藏
布尔值
如果为 true，用户将无法查看此属性的值
用户查看
布尔值
非管理员用户可以查看属性的值，并可以用它们进行过滤
__修改_用户
布尔值
用户可以自行更改此属性的值
隐藏_值_域_白名单
字符串
接收隐藏属性的目的地。一经设置便无法修改。
查询
HTTPQuery
展开 HTTPQuery 定义...
字段
字符串
请求的字段。

响应

200：用户属性

数据类型
说明
（对象）
可以
对象
当前用户可以对此对象执行的操作
id
字符串
唯一 ID
name
字符串
用户属性的名称
标签
字符串
方便用户使用的用户属性标签
类型
字符串
用户属性类型（“字符串”“数字”“日期时间”“是”“邮政编码”）
default_value
字符串
未设置用户时的默认值
is_system
布尔值
属性是系统默认属性
是永久的
布尔值
该属性是永久性的，无法删除
值已隐藏
布尔值
如果为 true，用户将无法查看此属性的值
用户查看
布尔值
非管理员用户可以查看属性的值，并可以用它们进行过滤
__修改_用户
布尔值
用户可以自行更改此属性的值
隐藏_值_域_白名单
字符串
接收隐藏属性的目的地。一经设置便无法修改。

400：错误请求

数据类型
说明
（对象）
消息
字符串
错误详情
文档网址
字符串
文档链接

404：未找到

数据类型
说明
（对象）
消息
字符串
错误详情
文档网址
字符串
文档链接

422：验证错误

数据类型
说明
（对象）
消息
字符串
错误详情
展开 ValidationErrorDetail 定义...
字段
字符串
出错的字段
代码
字符串
错误代码
消息
字符串
错误信息消息
文档网址
字符串
文档链接
文档网址
字符串
文档链接

429：请求数过多

数据类型
说明
（对象）
消息
字符串
错误详情
文档网址
字符串
文档链接