Skip to main content
POST
Register a platform user

Authorizations

Authorization
string
header
required

API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, settings:write, platform:read, platform:write; a *:write scope implies the matching *:read. Automation and dashboard endpoints also accept the legacy calls:* scope. Keys without scope restrictions have full access.

Body

application/json
email
string<email>
required
name
string
mode
enum<string>
default:invite

invite (default) creates the account without a password — pair it with POST /platform/users/{user_id}/token or .../login for your own custom auth flow. password sets an initial password you choose.

Available options:
invite,
password
password
string

Required when mode is password (min. 8 characters). Ignored otherwise.

Minimum string length: 8
timezone
string
Example:

"Europe/Berlin"

language
enum<string>
Available options:
en,
de,
fr,
es

Response

The new customer.

data
object
required