Create a tenant

POSThttps://api.trillet.ai/partner/v1/tenants

Creates a tenant for one of your customers. Needs tenants:write. Idempotency-Key is required.

If the workspace is created but its setup does not complete, the tenant is returned with status provisioning_failed.

Loading code example

Loading code example

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Header Parameters

Idempotency-Keystringrequired

1 to 255 printable ASCII characters, no spaces. A retry with the same key and request returns the stored response for 24 hours instead of running again.

Length: >= 1, <= 255

Body

externalIdstringrequired

Your ID for this customer. No leading or trailing spaces. Unique among your live tenants.

Length: >= 1, <= 128

namestringrequired

Length: >= 1, <= 100

region"us" | "au"

Defaults to your partner account's region. Decides where call data is stored.

Allowed values: "us" | "au"

metadataobject

Up to 8 KB of your own JSON data.

limitsobject

limits.monthlySpendCapnumber | null

Monthly spend cap in USD. null means no cap. 0 blocks all paid work.

Required range: x >= 0

Response

application/json

The new tenant.

objectstringrequired

idstringrequired

Use it in paths and as x-workspace-id on standard endpoints.

Pattern: ^[a-fA-F0-9]{24}$

externalIdstringrequired

Your ID for this customer.

namestringrequired

status"active" | "suspended" | "deleted" | "provisioning_failed"required

Allowed values: "active" | "suspended" | "deleted" | "provisioning_failed"

region"us" | "au"required

Allowed values: "us" | "au"

metadataobjectrequired

limitsobjectrequired

limits.monthlySpendCapnumber | null

Monthly spend cap in USD. null means no cap. 0 blocks all paid work.

Required range: x >= 0

suspendedAtstring | null<date-time>

suspendedReasonstring | null

deletedAtstring | null<date-time>

createdAtstring<date-time>required