Update tenant
PlatformUpdate supported tenant settings without changing tenant ownership or immutable identifiers.
Isolation
Tenant-scoped by design
Hierarchy
Organizations + sub-organizations
Access
Membership + role context
Configuration
Policies, modules & branding
PATCH
/v1/tenants/{id}Scope: tenants.writeEndpoint summary
| Method | Endpoint | Required scope |
|---|---|---|
| PATCH | /v1/tenants/{id} | tenants.write |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| id | string | Yes | Tenant identifier |
Request body
| Field | Type | Required | Description |
|---|---|---|---|
| organization_id | string | No | Owning organization |
| name | string | No | Tenant display name |
| tenant_type | string | No | Tenant category |
| region | string | No | Approved hosting region |
Example request
PATCH /v1/tenants/{id}Copy
PATCH /v1/tenants/{id}
Authorization: Bearer $ACCESS_TOKEN
Content-Type: application/json
{
"name":"Updated display name"
}Responses
| Code | Meaning |
|---|---|
| 200 | Updated successfully |
| 400 | Unsupported or invalid field |
| 403 | Insufficient access |
| 404 | Resource not found |
| 409 | Lifecycle or concurrency conflict |
Tenant model
| Field | Type | Description |
|---|---|---|
| id | string | Immutable tenant identifier |
| organization_id | string | Owning organization |
| tenant_type | enum | Operational tenant category |
| status | enum | provisioning, active, suspended, archived |
| region | string | Data / hosting region |
| settings | object | Tenant-specific non-secret configuration |