Concepts

Tenants

A tenant is your isolated workspace. Templates, contacts, providers, API keys, audit log — all scoped per-tenant.

When to create multiple tenants

Most teams use a single tenant. Reasons to spin up more:

  • Per environment — production, staging, dev. Avoids polluting prod templates with test data.
  • Per brand — you operate two consumer apps from one company; each has its own sender IDs and templates.
  • Per business unit — marketing team and engineering team need distinct API key sets.

Lifecycle

StateMeaning
activeNormal operation. API keys work, dashboard works.
suspendedAPI keys 401 with tenant_suspended. Dashboard loads in read-only mode. Reversible.
archivedSoft-deleted. 30-day retention then hard-deleted via cron. Undo available within the window.

Roles within a tenant

HIERARCHY

Higher roles include all lower-role permissions. owneradminmemberviewer.
RoleCan do
ownerDelete tenant, transfer ownership, all admin permissions
adminManage API keys, providers, sender IDs, members, templates
memberSend messages, view history, edit templates
viewerRead-only — see dashboards but not send or change anything