请求方式:POST(HTTPS)
请求地址:https://qyapi.weixin.qq.com/cgi-bin/school/user/update_parent?access_token=ACCESS_TOKEN
请求包体:
{
"parent_userid": "zhangsan_parent_userid",
"new_parent_userid":"NEW_ID",
"mobile": "18000000000",
"children":[
{
"student_userid": "zhangsan",
"relation": "爸爸"
},
{
"student_userid": "lisi",
"relation": "伯父"
}
]
}
参数说明:
参数 | 必须 | 说明 |
---|---|---|
access_token | 是 | 调用接口凭证。获取方法查看“获取access_token” |
parent_userid | 是 | 家长UserID。学校内必须唯一。不区分大小写,长度为1~64个字节。只能由数字、字母和“_-@.”四种字符组成,且第一个字符必须是数字或字母。 |
new_parent_userid | 否 | 更新的家长UserID。不能与已经存在的家长UserID相同。每个家长仅能更新一次。 |
mobile | 否 | 家长手机号 |
children | 否 | 家长的孩子列表,该字段是全量更新,如果孩子列表为空则忽略该字段,最多10个 |
children.student_userid | 是 | 学生的UserID |
children.relation | 是 | 家长与学生的关系,最长32字节 |
当参数字段超过长度限制,那么整个请求会被拦掉。
权限说明:
调用的应用需要满足如下的权限
应用类型 | 权限要求 |
---|---|
自建应用 | 配置到「 家校沟通-读取和编辑家校通讯录的应用」中 |
代开发应用 | 需拥有「家校沟通」可使用家校通讯录-家校通讯录编辑 权限 |
第三方应用 | 需拥有「家校沟通」使用和编辑 权限 |
注: 从2023年12月1日0点起,不再支持通过系统应用secret调用接口,存量企业暂不受影响 查看详情
返回结果:
{
"errcode": 0,
"errmsg": "updated"
}
参数说明:
参数 | 说明 |
---|---|
errcode | 返回码 |
errmsg | 对返回码的文本描述内容 |