tenants

Update Tenant

Update tenant settings and configuration.

Purpose: Complete your organization setup or modify settings

👤 For Business Users After Signup: After signing up, your tenant is auto-created with minimal fields (just name). Use this endpoint to complete your organization setup:

Set your organization name properly
Configure billing plan (starter/business/enterprise)
Set usage limits (max_concurrent_calls, monthly_call_limit)
Enable features (SIP, recording, analytics)
Configure compliance (HIPAA, PCI for healthcare/finance)

What it does:

Update organization name and billing plan
Adjust usage limits and concurrent call capacity
Enable/disable features (SIP, recording, analytics)
Change compliance settings (HIPAA, PCI)
Update SIP credentials (automatically encrypted)
Modify webhook configuration for integrations

Common Use Cases:

Initial Setup: After signup, set your org name and billing plan
Upgrade subscription: Change billing_plan, increase limits
Enable phone calls: Set sip_enabled=true, configure SIP details
Enable enterprise features: Set hipaa_enabled=true, pci_enabled=true
Update webhook: Change webhook_url for event notifications

Your tenant_id = your owner_id (returned in login token)

Security Notes:

SIP passwords are automatically encrypted before storage
Webhook secrets are stored securely
All changes are logged for audit trail

PUT

tenants

{tenant_id}

Update Tenant

curl --request PUT \
  --url https://api.example.com/tenants/{tenant_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "billing_plan": "<string>",
  "sip_enabled": true,
  "recording_enabled": true,
  "analytics_enabled": true,
  "max_concurrent_calls": 500,
  "monthly_call_limit": 1,
  "status": "<string>"
}
'

{
  "name": "<string>",
  "billing_plan": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "monthly_usage_cents": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "sip_enabled": false,
  "recording_enabled": true,
  "analytics_enabled": true,
  "max_concurrent_calls": 10,
  "monthly_call_limit": 1000,
  "meta_data": {},
  "sip_domain": "<string>",
  "sip_username": "<string>",
  "hipaa_enabled": false,
  "pci_enabled": false,
  "recording_format": "mp4",
  "retention_days": 90,
  "data_encryption_enabled": true,
  "webhook_url": "<string>",
  "webhook_timeout_seconds": 20
}

Authorizations

Authorization

string

header

required

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

Path Parameters

tenant_id

string<uuid>

required

Body

application/json

Tenant update model.

name

string | null

Required string length: 1 - 255

billing_plan

string | null

sip_enabled

boolean | null

recording_enabled

boolean | null

analytics_enabled

boolean | null

max_concurrent_calls

integer | null

Required range: 1 <= x <= 1000

monthly_call_limit

integer | null

Required range: x >= 0

status

string | null

Response

Successful Response

Tenant response model.

name

string

required

Required string length: 1 - 255

billing_plan

string

required

Required string length: 1 - 100

string<uuid>

required

status

string

required

monthly_usage_cents

integer

required

created_at

string<date-time>

required

updated_at

string<date-time>

required

sip_enabled

boolean

default:false

recording_enabled

boolean

default:true

analytics_enabled

boolean

default:true

max_concurrent_calls

integer

default:10

Required range: 1 <= x <= 1000

monthly_call_limit

integer

default:1000

Required range: x >= 0

meta_data

Meta Data · object

sip_domain

string | null

sip_username

string | null

hipaa_enabled

boolean

default:false

pci_enabled

boolean

default:false

recording_format

string

default:mp4

retention_days

integer

default:90

data_encryption_enabled

boolean

default:true

webhook_url

string | null

webhook_timeout_seconds

integer

default:20

Delete TenantDelete tenant from the platform (PERMANENT). **Purpose:** Remove a tenant/organization from the platform **What it does:** - Permanently deletes tenant account - Used when customer cancels service - Removes all tenant data from the system **⚠️ WARNING - CASCADE DELETE:** This operation permanently deletes ALL related data: - **All agents** created by this tenant - **Call history and recordings** (all calls) - **Workflows and integrations** (custom flows, API configs) - **Files and logs** (knowledge base, activity logs) - **SIP trunks** (phone number configurations) - **Squad configurations** (agent teams) **Use Cases:** - Customer account cancellation - Service termination - Data cleanup after trial expiration **Recommended Practice:** - Export/backup tenant data before deletion - Verify tenant has no active calls/sessions - Notify customer before deletion - Consider soft-delete (status=inactive) instead

Update Tenant

curl --request PUT \
  --url https://api.example.com/tenants/{tenant_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "billing_plan": "<string>",
  "sip_enabled": true,
  "recording_enabled": true,
  "analytics_enabled": true,
  "max_concurrent_calls": 500,
  "monthly_call_limit": 1,
  "status": "<string>"
}
'

{
  "name": "<string>",
  "billing_plan": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "<string>",
  "monthly_usage_cents": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "sip_enabled": false,
  "recording_enabled": true,
  "analytics_enabled": true,
  "max_concurrent_calls": 10,
  "monthly_call_limit": 1000,
  "meta_data": {},
  "sip_domain": "<string>",
  "sip_username": "<string>",
  "hipaa_enabled": false,
  "pci_enabled": false,
  "recording_format": "mp4",
  "retention_days": 90,
  "data_encryption_enabled": true,
  "webhook_url": "<string>",
  "webhook_timeout_seconds": 20
}

Documentation Index

Authorizations

Path Parameters

Body

Response