Skip to main content
PATCH
http://localhost:3000
/
tenants
/
{id}
curl -X PATCH 'https://api.example.com/tenants/tenant_acme' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "planKey": "enterprise",
    "maxUsers": 200,
    "maxWorkspaces": 50
  }'

{
  "id": "tenant_acme",
  "name": "Acme Corp",
  "kind": "standard",
  "scopeId": "scope_acme",
  "slug": "acme-corp",
  "planKey": "enterprise",
  "status": "active",
  "maxUsers": 200,
  "maxWorkspaces": 50,
  "updatedAt": "2024-01-16T10:30:00Z"
}

​
Path Parameters

​
id
string
required
The tenant ID to update

​
Request Body

All fields are optional. Only provided fields will be updated.
​
name
string
Display name
​
billingEmail
string
Billing email
​
technicalContactEmail
string
Technical contact email
​
planKey
string
Subscription plan key
​
status
string
Tenant status. One of: active, suspended, pending
​
maxUsers
number
Maximum users
​
maxWorkspaces
number
Maximum workspaces
​
logoUrl
string
Logo URL
​
primaryColor
string
Primary brand color
​
settings
object
Tenant settings
​
metadata
object
Custom metadata

​
Response

Returns the updated tenant object. 
curl -X PATCH 'https://api.example.com/tenants/tenant_acme' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{
    "planKey": "enterprise",
    "maxUsers": 200,
    "maxWorkspaces": 50
  }'

{
  "id": "tenant_acme",
  "name": "Acme Corp",
  "kind": "standard",
  "scopeId": "scope_acme",
  "slug": "acme-corp",
  "planKey": "enterprise",
  "status": "active",
  "maxUsers": 200,
  "maxWorkspaces": 50,
  "updatedAt": "2024-01-16T10:30:00Z"
}