Skip to content

Tenants API

MethodEndpointDescription
GET/tenants/List tenants for current user
POST/tenants/Create a new tenant
GET/tenants/{id}/Get tenant details
PUT/tenants/{id}/Update tenant
DELETE/tenants/{id}/Delete tenant
Terminal window
curl -X POST http://localhost:8000/tenants/ \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d '{
"name": "Acme Corp",
"description": "Main business tenant",
"vertical": "technology",
"country": "US",
"state": "CA"
}'
MethodEndpointDescription
GET/tenants/users/List users in tenant
POST/tenants/users/Add user to tenant
PUT/tenants/users/{id}/Update user’s role
DELETE/tenants/users/{id}/Remove user from tenant
MethodEndpointDescription
GET/tenants/roles/List roles
POST/tenants/roles/Create custom role
PUT/tenants/roles/{id}/Update role permissions
DELETE/tenants/roles/{id}/Delete custom role
RolePriorityCan be Deleted
Owner0No
Admin10No
Manager20No
Agent30No
Viewer40No
MethodEndpointDescription
GET/tenants/members/List members with roles
POST/tenants/members/Invite member
PUT/tenants/members/{id}/Change member role
DELETE/tenants/members/{id}/Remove member
MethodEndpointDescription
GET/tenants/tenant-tags/List tenant tags
POST/tenants/tenant-tags/Create tag
PUT/tenants/tenant-tags/{id}/Update tag
DELETE/tenants/tenant-tags/{id}/Delete tag
MethodEndpointDescription
GET/tenants/tenant-media/List uploaded media
POST/tenants/tenant-media/Upload media file
GET/tenants/tenant-media/{id}/Get media details
DELETE/tenants/tenant-media/{id}/Delete media

Media files are stored based on the STORAGE_BACKEND setting (local, S3, or GCS). Each media file can have platform-specific handle IDs (e.g., WhatsApp media IDs).

MethodEndpointDescription
GET/tenants/branding/Get branding settings
PUT/tenants/branding/{id}/Update branding

Branding is a singleton per tenant — favicon, primary logo, and secondary logo.

MethodEndpointDescription
GET/tenants/host-wallet/Get wallet balance
MethodEndpointDescription
GET/tenants/tenant-gupshup/List Gupshup app configs
POST/tenants/tenant-gupshup/Add Gupshup app
MethodEndpointDescription
GET/tenants/onboarding-options/Get available industry verticals, countries
MethodEndpointDescription
GET/tenants/waba-info/Get WhatsApp Business Account info

Returns account status, messaging tier, phone quality rating, throughput limit, and verified business name.