Create CRM sync
Create a recurring CRM sync using an existing API connection. Direction can import CRM records into Audience, push Audience contacts to the CRM, or both on the same schedule. Combined expressions are import-only; outbound needs a 1:1 phone or email mapping. The provider is resolved from the tenant-scoped connection and cannot be supplied by the caller. 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.
Body
1 - 1281 - 128External source to Audience target. A bare key keeps legacy 1:1 behavior. To combine fields or fixed text, use non-evaluated {{field}} tokens in one source expression, for example {{salutation}} {{firstName}} {{lastName}} or +49{{phone}}. 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.
Provider-neutral source selection. Discovered list/view/filter IDs use sourceId. Set default_phone_country to a supported ISO-2 code (for example DE) to normalize national phone numbers; international +/00 values take priority. Required provider fields are derived from the mapping.
5 <= x <= 10080ignore, clear deactivate_membership, keep review, skip inbound imports CRM records into Audience. outbound pushes Audience contacts to the CRM. bidirectional runs inbound first, then outbound, on the same schedule.
inbound, outbound, bidirectional When direction includes outbound, create CRM records for unlinked Audience contacts. Defaults to true for outbound-only syncs.
Response
Created CRM sync.