Sign in
Max Settings

Update the Max email settings for a mailbox

Updates one connected mailbox's email behaviour — auto-drafting, labels, signature, and contact auto-creation. Settings are per mailbox, so a user with several mailboxes configures each one separately. Switching categorizationEnabled, draftEnabled or followupEnabled on requires the MAX_EMAIL_AGENT license on the user's seat; switching them off always works. Requires a USER API key.

put/public/v1/max/settings/email/{connectedAccountId}

Path parameters

connectedAccountIdstring required
Example:example

Request body

categorizationEnabledboolean
categorizationInstructionsstring nullable
toRespondSensitivity'LEVEL_1' | 'LEVEL_2' | 'LEVEL_3' | 'LEVEL_4'
marketingSensitivity'LEVEL_1' | 'LEVEL_2' | 'LEVEL_3' | 'LEVEL_4'
draftEnabledboolean
draftInstructionsstring nullable
customSignaturestring nullable
followupEnabledboolean
followUpInstructionsstring nullable
followUpAfterinteger
emailProcessingEnabledboolean
contactSyncEnabledboolean
autoCreateContactsModeOverride'ALL_CONTACTS' | 'SELECTIVE' | 'NONE' nullable
linkMaxContactToPeopleOverrideboolean nullable
peopleSyncDefaultOverrideboolean nullable
peopleSyncRecordTypeIdinteger nullable

Example request

{
  "categorizationInstructions": "example",
  "toRespondSensitivity": "LEVEL_1",
  "marketingSensitivity": "LEVEL_1",
  "labels": [
    {
      "id": 1,
      "color": "SALMON",
      "name": "example",
      "description": "example"
    }
  ],
  "draftInstructions": "example",
  "customSignature": "example",
  "followUpInstructions": "example",
  "followUpAfter": 1,
  "autoCreateContactsModeOverride": "ALL_CONTACTS",
  "peopleSyncRecordTypeId": 1
}

Response

Updated email settings

oktrue required

Example response

{
  "ok": true,
  "data": {
    "connectedAccountId": 1,
    "connectedEmail": "example",
    "toolkit": "example",
    "customLabelsLimit": 1,
    "categorizationInstructions": "example",
    "toRespondSensitivity": "LEVEL_1",
    "marketingSensitivity": "LEVEL_1",
    "labels": [
      {
        "id": 1,
        "name": "example",
        "color": "example",
        "guidelines": "example",
        "description": "example",
        "type": "SYSTEM",
        "createdAt": "example",
        "updatedAt": "example"
      }
    ],
    "draftInstructions": "example",
    "customSignature": "example",
    "writingStyle": "example",
    "followUpInstructions": "example",
    "followUpAfter": 1,
    "autoCreateContactsModeOverride": "ALL_CONTACTS",
    "peopleSyncRecordTypeId": 1,
    "effectiveAutoCreateContactsMode": "ALL_CONTACTS",
    "effectivePeopleSyncRecordTypeId": 1,
    "accountDefaultRecordTypeId": 1
  }
}

Changes

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