Skip to content
开发文档
能力中心
应用市场
WebOffice
开发者后台

新增自定义用户属性

批量新增自定义用户属性

请求说明

请求地址https://openapi.wps.cn/v7/companies/user_custom_attrs/batch_create
请求方法POST
签名方式KSO-1
权限要求查询和管理用户自定义字段(应用授权) kso.user_custom_attr.readwrite

请求头(Header)

Header 名称参数类型是否必填说明
Content-Typestring使用:application/json
X-Kso-DatestringRFC1123 格式的日期,例: Wed, 23 Jan 2013 06:43:08 GMT
X-Kso-AuthorizationstringKSO-1 签名值,详见《签名方法》
Authorizationstring授权凭证,格式为:Bearer {access_token}

请求体(Body)

名称参数类型是否必填说明
custom_attrsarray[object]自定义属性
∟ namestring自定义属性名称
∟ custom_optionsarray[object]自定义属性 type 为 option 时,展示的选项列表
∟ ∟ keystringkey 值,修改 / 新增时作为入参值
∟ ∟ namestring显示名
∟ value_typestring[enum]值类型
text relation_user relation_depts option

请求地址示例

[POST] https://openapi.wps.cn/v7/companies/user_custom_attrs/batch_create

请求体示例

json
{
  "custom_attrs": [
    {
      "name": "string",
      "custom_options": [
        {
          "key": "string",
          "name": "string"
        }
      ],
      "value_type": "string[enum]"
    }
  ]
}

响应体

名称参数类型说明
codeinteger响应代码。非 0 表示失败,参照《状态码说明》
msgstring响应信息
dataobject响应数据
∟ attr_idsarray[string]自定义属性 id

响应体示例

json
{
  "data": {
    "attr_ids": ["string"]
  },
  "msg": "string",
  "code": 0
}
回到旧版