Skip to main content
GET
Check hosted email name

Authorizations

Authorization
string
header
required

API key (fam_..., created under Settings → API Keys) or an OAuth 2.0 access token (fam_at_...). REST operations also require API Access for the credential's workspace. Keys can be restricted to scopes such as assistants:read, calls:write, campaigns:write, automations:read, dashboards:read, dashboards:write, leads:write, segments:write, loop:read, loop:write, phone_numbers:write, sip_trunks:write, knowledge:write, voices:read, billing:read, billing:write, 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 within the workspace's available capabilities.

Query Parameters

local_part
string
required

Username before the @. A check does not reserve the name.

Required string length: 1 - 64
domain_id
string<uuid>

Hosted domain UUID from getEmailChannelOptions. Defaults to the first available hosted domain.

Response

Check hosted email name

data
object
required