Skip to main content
PATCH
Update CRM sync

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

CRM sync ID.

Body

application/json

Partial CRM sync update. All fields are optional; the connection is immutable.

name
string
Required string length: 1 - 128
object_type
string
Required string length: 1 - 128
selection
object

Replacement provider-neutral selection. default_phone_country accepts a supported ISO-2 country code.

field_mapping
object

Replacement mapping. Bare source keys stay 1:1; composed values use non-evaluated {{field}} tokens and optional literal text. At least one target must be phone or email, and each target appears once.

interval_minutes
integer
Required range: 5 <= x <= 10080
status
enum<string>
Available options:
active,
paused
null_policy
enum<string>
Available options:
ignore,
clear
removal_policy
enum<string>
Available options:
deactivate_membership,
keep
conflict_policy
enum<string>
Available options:
review,
skip

Response

Updated CRM sync.