v49

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

Tenants

Create a tenant

Create a new tenant.

Returns the created tenant with a unique id. Store this ID in your database to reference this tenant later.

post/tenants

Request body

namestring required

Display name for the tenant (e.g., your customer's company name)

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

Example request

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

Response

Tenant created

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"
  }
}