Update home member role
PATCH/homes/{homeId}/members/{userId}
Base URL: https://api.tinkermode.com
Update the home member with the specified user ID. Only the "role" of the member can be changed at this time. Regular members of a home are not permitted to make this request.
Authentication
Send an Authorization header of the form ModeCloud <AUTH_CODE>.
Must contain user API key of the home owner, a service account token with manage-permissions on the home, or Project API key with "Admin" privileges.
Path parameters
| Name | Type | Required | Constraints | Description |
|---|---|---|---|---|
homeId | integer | Yes | The unique ID for a specified home. | |
userId | integer | Yes | The unique ID for a specified user. |
Request body
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
creationTime | string | No | read-only (server-generated); format: date-time | Timestamp when member was added to home. |
email | string | No | read-only (server-generated) | Email address of member. |
name | string | No | read-only (server-generated) | Display name of member. |
phoneNumber | string | No | read-only (server-generated); pattern: ^(\+)([0-9]{5,})$ | Phone number used by member. Must begin with country code (beginning with the '+' symbol). |
role | unknown | No | one of: owner, member | If the role is OWNER, this member can add or remove other members. |
userId | integer | Yes | read-only (server-generated) | User ID of home member. |
verified | boolean | Yes | read-only (server-generated) | True if member is a verified user. |
Request example
{
"role": "owner"
}Responses
204 Successfully updated home member's role. There is no return body.
401 Authorization is required to access this resource.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
403 Request failed because of invalid data or denied permission.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
404 The requested member does not exist or is not accessible.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
429 Request failed because of rate limit.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
500 An unexpected error has occurred.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |
503 The service is temporarily unavailable.
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
data | object | No | read-only (server-generated) | Any relevant data related to error. |
reason | string | Yes | read-only (server-generated) | Reason of error. |