Description
Updates a tenant. Pass only the fields you want to change - a field left out keeps its current value.
Archived tenants can be updated too. Updating never counts against the plan limit.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
tenantId |
body | string | yes | ID of the tenant. |
name |
body | string | no | New name, unique in the workspace. |
description |
body | string | no | New description. |
tagIds |
body | array<string> | no | The complete set of tag IDs the tenant should carry. Send [] to remove all tags. |
Errors
| Status | Meaning |
|---|---|
400 |
Invalid tenantId, a validation failure, or a tag that is not in this workspace. |
401 |
Missing or invalid Basic auth credentials, or the service account lacks permission to manage tenants in this workspace. |