七鱼开发文档中心
总览服务端 APIWebiOSAndroid鸿蒙Uniapp微信小程序插件三方接入
客户管理

批量更新用户标签

批量更新多个用户的标签。请求体为 JSON 数组,每项包含 foreignId/phone(至少一个)、tagIds(标签 ID 数组)、type(save/delete/replace)。单次最多 200 条(可配置)。需要企业开通客户标签服务。

请求参数

名称类型必填描述示例值
appKeystring是应用 AppKey
timeint64是请求时间戳(秒)
checksumstring是请求签名校验和

请求体

名称类型必填描述示例值
foreignIdstring否用户唯一标识(foreignId),与 phone 二选一user_12345
phonestring否用户手机号,与 foreignId 二选一13800138000
tagIdsint64[]是标签 ID 数组[1001,1002]
typestring是操作类型:save-添加,delete-删除,replace-替换save

返回参数

名称类型描述示例值
codeint32状态码,200 表示成功200
messagestring提示信息update user tag success
resultobject批量更新用户标签结果
└foreignIdsNotExiststring[]不存在的 foreignId 列表["uid_unknown1"]
└mobilesNotExiststring[]不存在的手机号列表["13800001111"]
└tagIdsNotExistint64[]不存在的标签 ID 列表[9999]

错误码

状态码描述
14001AppKey 不存在
14002checksum 校验失败
14003请求时间戳与服务器时间误差超过 10 分钟
14004请求体 JSON 格式错误;超过批量上限;JSON 解析失败
14500服务内部异常
14515企业未开通客户标签服务
postEndpoint
/openapi/tag/batchUpdate
POST
/openapi/tag/batchUpdate
curl -X POST "https://qiyukf.com/openapi/tag/batchUpdate?appKey=string&time=1739347200&checksum=a1b2c3d4e5f607182930abcdefabcdef" \  -H "Content-Type: application/json" \  -d '{    "tagIds": [      1001,      1002    ],    "type": "save"  }'
{
  "code": 200,
  "message": "update user tag success",
  "result": {
    "foreignIdsNotExist": [
      "uid_unknown1"
    ],
    "mobilesNotExist": [
      "13800001111"
    ],
    "tagIdsNotExist": [
      9999
    ]
  }
}
{
  "code": 14001,
  "message": "AppKey 不存在"
}
{
  "code": 14002,
  "message": "checksum 校验失败"
}
{
  "code": 14003,
  "message": "请求时间戳与服务器时间误差超过 10 分钟"
}
{
  "code": 14004,
  "message": "请求体 JSON 格式错误;超过批量上限;JSON 解析失败"
}
{
  "code": 14500,
  "message": "服务内部异常"
}
{
  "code": 14515,
  "message": "企业未开通客户标签服务"
}

这篇文档有帮助吗?