Add Home Member

Last Updated on : 2024-09-10 09:51:54

Add members to a specified home.

API address

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

Parameter name	Type	IN	Required	Description
home_id	Long	uri	true	The ID of a home.

Description of body

Parameter name	Type	IN	Required	Description
app_schema	String	body	true	The account schema.
member	Object	body	true	The member's object.

Description of member

Parameter name	Type	IN	Required	Description
country_code	String	body	true	The country code.
member_account	String	body	true	The member's account.
admin	Boolean	body	true	Specifies whether the user is an administrator.
name	String	body	true	The member's name.

Parameter name	Type	Description
result	Boolean	`true` is returned when the operation is successful.

POST: /v1.0/homes/2422120/members

{
  "app_schema": "test",
  "member": {
    "country_code": "86",
    "member_account": "1565815****",
    "admin": false,
    "name": "James"
  }
}

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

For more information, see error code.