Update a home
PATCH/homes/{homeId}
Base URL: https://api.tinkermode.com
Update the home with the specified ID. However, the deactivated field of a home can be changed only if the request is made using a project API key with "Admin" privileges.
Authentication
Send an Authorization header of the form ModeCloud <AUTH_CODE>.
Must contain a user API key, a service account token, or a project API key with "Admin" privileges.
Path parameters
| Name | Type | Required | Constraints | Description |
|---|---|---|---|---|
homeId | integer | Yes | The unique ID for a specified home. |
Request body
Content type: application/json
| Property | Type | Required | Constraints | Description | ||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
creationTime | string | No | read-only (server-generated); format: date-time | Timestamp of home creation. | ||||||||||||||||||||
deactivated | boolean | No | True if home has been deactivated by project admin. | |||||||||||||||||||||
id | integer | Yes | read-only (server-generated) | Unique ID assigned at time of creation. | ||||||||||||||||||||
name | string | Yes | Display name of home. | |||||||||||||||||||||
projectId | integer | Yes | read-only (server-generated) | Project that this home belongs to. | ||||||||||||||||||||
tenant | object | No | Tenant information associated with a home. | |||||||||||||||||||||
| ||||||||||||||||||||||||
Request example
{
"name": "New_Home"
}Responses
204 Successfully updated home with specified ID. 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 home 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. |