Sign in
Data & Sync

Get the account WhatsApp settings

Returns the account-wide defaults for personal WhatsApp sync: whether contacts are created automatically, which chats are in scope, and whether muted, archived, or group chats are excluded. These govern each user's own connected WhatsApp — the Business numbers your agents answer on are separate, under Agent Channels. Read-only. 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 edited in the app by an administrator and there is no API or CLI write. preferenceOverridePolicy tells you whether they act as defaults each user may change in their own Max settings or as hard settings they cannot. Accepts an account API key, or a USER API key belonging to an OWNER or ADMIN.

get/public/v1/settings/whatsapp

Response

Account WhatsApp settings

oktrue required

Example response

{
  "ok": true,
  "data": {
    "autoCreateContactsMode": "ALL_CONTACTS",
    "syncScopeDefault": "ALL_CHATS",
    "peopleSyncRecordTypeId": 1,
    "preferenceOverridePolicy": "NONE",
    "ignoreListOverridePolicy": "NONE"
  }
}

Changes

Changed in 1 of the 2 revisions of this API.1