Sign in
Max Proactive

Get the Max proactive settings

Returns whether Max may reach out unprompted, and under what conditions: the channel it uses, how often it may interrupt, the hours it is allowed to write in, whether weekends are fair game, which events it reacts to, and free-form instructions on what is worth a nudge. Read-only — these settings govern when Max may act on its own, so they are changed in the app by the user themselves and cannot be written through the API. Requires a USER API key.

get/public/v1/max/settings/proactive

Response

Proactive settings

oktrue required

Example response

{
  "ok": true,
  "data": {
    "preferredChannel": "AUTO",
    "frequency": "RELAXED",
    "deliveryWindowStart": 1,
    "deliveryWindowEnd": 1,
    "enabledEventTypes": [
      "MEETING_COMPLETED_WITH_ACTION_ITEMS"
    ],
    "proactiveInstructions": "example",
    "lastProactiveContactAt": "example"
  }
}

Changes

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