Skip to content
Last updated

Data & Sync

Data & Sync are the account-wide defaults for how email, WhatsApp, calendar, and meetings turn activity into CRM records — contact auto-creation, People linking, record assignment, and whether each setting is a default users may change or a hard setting they cannot.

A single write here changes behaviour for every user in the account at once (including data residency, retention, and who may see whose activity), so these defaults are read-only on the Public API. An administrator edits them in the app. preferenceOverridePolicy on each payload tells you whether they act as defaults each user may change in their own Max settings, or as hard settings they cannot.

Requires an account API key, or a USER API key belonging to an OWNER or ADMIN. A USER key that is not OWNER/ADMIN gets 404.

A user's own overrides live in Max settings. Meeting volume across the account is GET /meetings/analytics. The Business numbers your agents answer on are Agent Channels, not the personal WhatsApp sync here.

Surfaces

ChannelPathWhat the defaults cover
EmailGET /public/v1/settings/emailAuto-create contacts from mail, link them to People, who the record is assigned to, whether admins may view everyone's mail
WhatsAppGET /public/v1/settings/whatsappPersonal WhatsApp sync: auto-create contacts, which chats are in scope, whether muted/archived/group chats are skipped
CalendarGET /public/v1/settings/calendarWhether attendees become contacts, skip internal colleagues, which People record type new contacts are created as
MeetingsGET /public/v1/settings/meetingsNotetaker bot name/avatar, recording region, retention, custom vocabulary, reminders, how participants become CRM records, who may create folders and note templates

Operations

VerbPathPurpose
GET/public/v1/settings/emailAccount email defaults
GET/public/v1/settings/whatsappPersonal WhatsApp defaults
GET/public/v1/settings/calendarCalendar defaults
GET/public/v1/settings/meetingsNotetaker defaults

Full list in the API Reference under the Data & Sync tag.

CLI

frontline settings email get --pretty
frontline settings whatsapp get --pretty
frontline settings calendar get --pretty
frontline settings meetings get --pretty