v49

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-02-185890337.1 KB

Tenants

Update a tenant

Update a tenant's name, metadata, or status. At least one field is required.

Metadata is replaced entirely—include all keys you want to keep.

patch/tenants/{tenantId}

Path parameters

tenantIdstring required

The tenant ID

Request body

namestring

Display name for the tenant

metadataTenantMetadata nullable

Custom key-value pairs. Useful for storing references to your internal systems.

Limits:

Max 50 keys
Key names max 40 characters
String values max 500 characters
Total size max 8KB

status'active' | 'suspended' | 'archived'

Tenant status

Example request

{
  "name": "Acme Corporation",
  "metadata": {
    "plan": "pro",
    "internalId": "cust_12345",
    "region": "us-west"
  },
  "status": "active"
}

Response

Tenant updated

successtrue required

Example response

{
  "data": {
    "id": "cm6abc123def456ghi789",
    "name": "Acme Corp",
    "metadata": {
      "plan": "pro",
      "internalId": "cust_12345"
    },
    "status": "active",
    "createdAt": "2026-02-03T10:30:00Z",
    "updatedAt": "2026-02-03T10:30:00Z"
  },
  "meta": {
    "requestId": "req_V1StGXR8_Z5jdHi6"
  }
}