Skip to main content
POST
Create an email address

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
domain_id
string<uuid>
required

Must belong to an already-verified domain.

local_part
string
required
Example:

"support"

assistant_id
string<uuid> | null
display_name
string | null
Maximum string length: 128

Response

The created address.

data
object
required