Skip to main content
POST
Create an Audience contact

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, loop:read, loop: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
phone
string | null
required

Phone number normalized to E.164.

email
string<email> | null
name
string | null
tags
string[]
Maximum array length: 32
Maximum string length: 40
custom_fields
object

User-managed contact fields. Infrastructure-managed keys are ignored.

Response

The request matched and enriched an existing contact.

data
object
required