Get the account email settings
Returns the account-wide email defaults every user inherits: whether contacts seen in mail are created automatically and under what conditions, whether those contacts are linked to People records, who the created record is assigned to, and whether administrators may view everyone's email activity. 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.
Response
Account email settings
Example response
{
"ok": true,
"data": {
"autoCreateContactsMode": "ALL_CONTACTS",
"peopleSyncRecordTypeId": 1,
"preferenceOverridePolicy": "NONE",
"ignoreListOverridePolicy": "NONE"
}
}Changes
Changed in 1 of the 2 revisions of this API.1
- ○
endpoint added
endpoint-added
This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ○