Skip to main content
Endpoints to retrieve and modify tenant settings — personality, widget, security, and integrations.

GET /tenants/

Retrieve tenant information. Required scope: settings:read

Request

Response

The tenant object is wrapped in a tenant key, alongside stats, recentConversations, and a ready-to-paste embedCode. conversationsLimit is the effective cap (plan base plus any paid bot seats), not the raw stored limit.

PUT /tenants/

Modify tenant settings. Send only the fields you want to update. Required scope: settings:write

Request

Response

Returns the full updated tenant object.

Modifiable fields

Personality

Appearance

Security

Booking CTA

Status

Usage statistics are returned inline by GET /tenants/{slug} under the stats key — there is no separate stats endpoint.