简体中文
简体中文
English
联系我们
注册
登录
layout空间导航

添加家庭成员 

更新时间:2022-04-29 05:34:50下载pdf

本文介绍添加家庭成员 的 API。

接口描述

给某个家庭添加家庭成员。

接口地址

POST: /v1.0/homes/{home_id}/members

请求参数

参数名类型参数位置是否必填说明
home_idLonguritrue家庭 ID

body 说明

参数名类型参数位置是否必填说明
app_schemaStringbodytrue账号标识
memberObjectbodytrue成员对象

member 说明

参数名类型参数位置是否必填说明
country_codeStringbodytrue国家码
member_accountStringbodytrue成员账号
adminBooleanbodytrue是否为管理员
nameStringbodytrue成员名字

返回参数

参数名类型说明
resultBoolean添加成功返回 true。

请求示例

POST: /v1.0/homes/2422120/members
{
  "app_schema": "test",
  "member": {
    "country_code": "86",
    "member_account": "1565815****",
    "admin": false,
    "name": "⼩明"
  }
}

返回示例

{
    "result": true,
    "t": 1540799657137,
    "success": true
}

错误码

参考 错误码