Skip to main content
POST
Create a platform user token

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.

Path Parameters

user_id
string<uuid>
required

Body

application/json
name
string
default:Platform access token
Maximum string length: 100
scopes
string[]

Subset of the canonical API scopes to grant this token. Omitted or empty = full access for this customer — this is a completely different principal than your own operator credential, so it is NOT limited to your own credential's scopes.

expires_in_days
integer

Omitted = the token never expires.

Required range: 1 <= x <= 365
workspace_id
string<uuid>

Pick a specific workspace when the customer has several in your scope; defaults to the one they own.

Response

The minted token (shown once).

data
object
required