Sign in
Max Settings

Get the Max email settings for a mailbox

Returns the per-mailbox email configuration: auto-drafting and its sensitivity, the labels Max applies, signature handling, and whether contacts are created automatically from correspondents. The connectedAccountId is the mailbox integration's id, from GET /max/integrations. emailAgentEnabled reports whether this user's Max seat holds the MAX_EMAIL_AGENT license; while it is false the labeling, drafting and follow-up flags are stored but have no effect. Requires a USER API key.

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

Path parameters

connectedAccountIdstring required
Example:example

Response

Email settings for the mailbox

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