Update CRM sync
Patch source selection, field mapping, interval, direction, outbound create, policies, or active/paused status. Mapping and source changes reset the cursor but keep the existing schedule; use POST /crm-syncs//runs to sync immediately. Requires automations:write or calls:write.
Authorizations
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, 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.
Path Parameters
CRM sync ID.
Body
Partial CRM sync update. All fields are optional; the connection is immutable.
1 - 1281 - 128Replacement provider-neutral selection. default_phone_country accepts a supported ISO-2 country code.
Replacement mapping. Bare source keys stay 1:1; composed values use non-evaluated {{field}} tokens and optional literal text. Destinations include channel identities such as channel.telegram.username or channel.whatsapp.user_id. At least one target must be phone or email, and each target appears once.
5 <= x <= 10080active, paused ignore, clear deactivate_membership, keep review, skip inbound, outbound, bidirectional Response
Updated CRM sync.