Update the Tenant information
PATCH/projects/{projectId}/tenants/{homeId}
Base URL: https://api.tinkermode.com
Update a tenant from a multi-tenant project. Currently, only the tenant identifier can be updated.
Prerequisites:
- The project must have multi-tenancy enabled
- The home (tenant) must have the 'tenant' field in its metadata
- The new tenant identifier must be different from the current identifier
- The new tenant identifier must be unique across all tenants in the project
Required Permissions:
- Permission to update the home.
Authentication
Send an Authorization header of the form ModeCloud <AUTH_CODE>.
Must contain a user API key of a user with tenant update permissions, a service account token with the same permission, or a project API key with admin permissions.
Path parameters
| Name | Type | Required | Constraints | Description |
|---|---|---|---|---|
projectId | integer | Yes | The unique ID for a specified project. | |
homeId | integer | Yes | The unique ID of the home. |
Request body
Content type: application/json
| Property | Type | Required | Constraints | Description |
|---|---|---|---|---|
identifier | string | No | pattern: ^[a-z0-9-]+$ | Unique identifier for the tenant within the project. Must be URL-safe and contain only lowercase letters, numbers, and hyphens. Cannot contain spaces. |
Request example
{
"identifier": "acme-corp-site-1"
}Responses
204 Tenant successfully updated.
401 Authorization is required to access this resource.
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. |
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. |