Skip to main content
POST
Call a translation participant

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.

Headers

Idempotency-Key
string<uuid>
required

Path Parameters

id
string<uuid>
required

Body

application/json
side
enum<integer>
required
Available options:
1,
2
phone_number
string
required

International E.164 telephone number.

Pattern: ^\+[1-9]\d{6,14}$
phone_number_id
string<uuid>

Response

Success

data
object
required