Suspend a tenant

POSThttps://api.trillet.ai/partner/v1/tenants/{tenantId}/suspend

Stops the tenant's traffic and keeps everything else. Outbound calls, web calls and SMS are refused, new workflow runs are skipped, and inbound calls are answered and ended at once. Needs tenants:write.

Loading code example

Loading code example

Authorizations

Authorizationstringheaderrequired

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

Path Parameters

tenantIdstringrequired

The tenant ID.

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

Body

reasonstring

Returned as suspendedReason.

Length: <= 500

Response

application/json

The tenant, with status suspended.

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