Tenant (your account)

The tenant your key belongs to.

The tenant your key belongs to.

Base URL https://api.whabuzz.com. Every request needs Authorization: Bearer <key> unless the operation says otherwise; see Authentication. Errors follow the two-source contract.

Operations on this page:

• GET /v1/tenant: Current tenant, including the Getting-started checklist
• PATCH /v1/tenant: Update retention or billing email

#Current tenant, including the Getting-started checklist

GET/v1/tenant

Allowed for every tenant status, so a pending tenant can see why it is blocked.

Auth: API key (tenant key, or app key with X-WhaBuzz-Tenant). Operation id: getTenant.

cURL:

curl -X GET "https://api.whabuzz.com/v1/tenant" \
  -H "Authorization: Bearer $WHABUZZ_KEY"

Responses

200 Tenant

{
  "id": "a578246e-b97f-48e6-ae42-939ec3ccf917",
  "name": "Acme Fitness",
  "status": "active",
  "sandbox": false,
  "retention_days": 90,
  "billing_status": "trialing",
  "trial_ends_at": "2026-10-30T09:00:00Z",
  "created_at": "2026-10-16T09:00:00Z",
  "checklist": {
    "number_connected": true,
    "api_key_created": true,
    "webhook_verified": false,
    "test_message_sent": false
  }
}

Common errors. Shape and meanings are on the Errors page.

#Update retention or billing email

PATCH/v1/tenant

Auth: API key (tenant key, or app key with X-WhaBuzz-Tenant). Operation id: updateTenant.

Request body (application/json, required)

Request example:

{
  "retention_days": 180
}

cURL:

curl -X PATCH "https://api.whabuzz.com/v1/tenant" \
  -H "Authorization: Bearer $WHABUZZ_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "retention_days": 180
}'

Responses

200 Updated tenant

{
  "id": "a578246e-b97f-48e6-ae42-939ec3ccf917",
  "name": "Acme Fitness",
  "status": "active",
  "retention_days": 180
}

Common errors. Shape and meanings are on the Errors page.

This page as Markdown: /api/tenant.md. All docs in one file: /llms-full.txt.