# 设置用户备注名

调试工具

接口应在服务器端调用,不可在前端(小程序、网页、APP等)直接调用,具体可参考接口调用指南

接口英文名:updateRemark

本接口用于对指定用户设置备注名,该接口暂时开放给微信认证的服务号。 接口调用请求说明。

# 1. 调用方式

# HTTPS 调用

POST https://api.weixin.qq.com/cgi-bin/user/info/updateremark?access_token=ACCESS_TOKEN

# 云调用

  • 调用方法:officialAccount.user.updateRemark

  • 出入参和 HTTPS 调用相同,调用方式可查看 云调用 说明文档

# 第三方调用

  • 本接口支持第三方平台代商家调用。

  • 该接口所属的权限集 id 为:2、100

  • 服务商获得其中之一权限集授权后,可通过使用 authorizer_access_token 代商家进行调用,具体可查看 第三方调用 说明文档。

# 2. 请求参数

# 查询参数 Query String parameters

参数名类型必填说明
access_tokenstring接口调用凭证,可使用 access_tokenauthorizer_access_token

# 请求体 Request Payload

# 3. 返回参数

# 返回体 Response Payload

参数名类型说明
errcodenumber返回码
errmsgstring错误信息

# 4. 注意事项

本接口无特殊注意事项

# 5. 代码示例

# 5.1 设置备注成功

请求示例

{
  "openid": "oDF3iY9ffA-hqb2vVvbr7qxf6A0Q",
  "remark": "pangzi"
}

返回示例

{
  "errcode": 0,
  "errmsg": "ok"
}

# 5.2 设置备注失败

请求示例

{
  "openid": "oDF3iY9ffA-hqb2vVvbr7qxf6A0Q",
  "remark": "pangzi"
}

返回示例

{
  "errcode": 40013,
  "errmsg": "invalid appid"
}

# 6. 错误码

以下是本接口的错误码列表,其他错误码可参考 通用错误码

错误码错误描述解决方案
-1system error系统繁忙,此时请开发者稍候再试
0ok成功
40001invalid credential  access_token isinvalid or not latest获取 access_token 时 AppSecret 错误,或者 access_token 无效。请开发者认真比对 AppSecret 的正确性,或查看是否正在为恰当的公众号调用接口
40003invalid openid不合法的 OpenID ,请开发者确认 OpenID (该用户)是否已关注公众号,或是否是其他公众号的 OpenID
40013invalid appidAppID无效错误

# 7. 适用范围

本接口在不同账号类型下的可调用情况:
公众号服务号
仅认证 仅认证
  • 仅认证:表示仅允许企业主体已认证账号调用,未认证或不支持认证的账号无法调用
  • 其他未明确声明的账号类型,如无特殊说明,均不可调用此接口;