Add a home member

Description

Add a member to the home. Only existing home members with the OWNER role may make this request. Based on the type of the project, this API call does one of the following:

Project Uses the Built-In Account System (Based on Email Addresses)

Add a member to the home. The member's email address must be specified. If the member is not an existing user, the "verified" field of the returned member object will be false. An email notification will be sent to the invited member.

Project Uses the Built-In Account System (Based on Phone Numbers)

Add a member to the home. The member's phone number must be specified. If the member is not an existing user, the "verified" field of the returned member object will be false. It is the app's responsibility to send an SMS invite to the invited member.

Project is BYOU ("Bring-Your-Own-Users")

Add an existing user with the specified user ID to a home.

Path parameters

Request body

Content type: application/x-www-form-urlencoded

phoneNumber=%2B17149999999

Responses

{
  "creationTime": "2019-12-18T20:12:13.478Z",
  "phoneNumber": "+17149999999",
  "role": "owner",
  "userId": 2083,
  "verified": false
}