Skip to main content
POST

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

id
string<uuid>
required

Campaign ID.

Body

application/json
phone
string
required

Phone number; normalized to E.164 (e.g. +4915123456789).

name
string | null
custom_fields
object

Arbitrary key/value data available to the assistant during the call.

Response

Created lead(s). Single body → data is the lead object; array body → data is an array plus meta.created / meta.dnc_flagged / meta.invalid.

data
object
required