Sign in
Max Settings

Update the Max general settings

Changes Max's language, personality, timezone, or custom instructions for the calling user. Custom instructions are the main lever for steering tone and defaults across every conversation. Requires a USER API key.

put/public/v1/max/settings/advanced

Request body

preferredLanguage'ENGLISH' | 'SPANISH' | 'PORTUGUESE' | 'FRENCH' | 'GERMAN' | 'ITALIAN'
instructionsstring nullable
slackPreApprovePlansboolean
whatsAppPreApprovePlansboolean
slackAuthorizationMode'AUTO' | 'SUPERVISED' | 'ASK'
whatsAppAuthorizationMode'AUTO' | 'SUPERVISED' | 'ASK'
teamsAuthorizationMode'AUTO' | 'SUPERVISED' | 'ASK'
webAuthorizationMode'AUTO' | 'SUPERVISED' | 'ASK'
slackModelTier'AUTO' | 'LITE' | 'HIGH'
whatsAppModelTier'AUTO' | 'LITE' | 'HIGH'
teamsModelTier'AUTO' | 'LITE' | 'HIGH'

Example request

{
  "preferredLanguage": "ENGLISH",
  "instructions": "example",
  "slackAuthorizationMode": "AUTO",
  "whatsAppAuthorizationMode": "AUTO",
  "teamsAuthorizationMode": "AUTO",
  "webAuthorizationMode": "AUTO",
  "slackModelTier": "AUTO",
  "whatsAppModelTier": "AUTO",
  "teamsModelTier": "AUTO"
}

Response

Updated general settings

oktrue required

Example response

{
  "ok": true,
  "data": {
    "preferredLanguage": "ENGLISH",
    "instructions": "example",
    "slackAuthorizationMode": "AUTO",
    "whatsAppAuthorizationMode": "AUTO",
    "teamsAuthorizationMode": "AUTO",
    "webAuthorizationMode": "AUTO",
    "slackModelTier": "AUTO",
    "whatsAppModelTier": "AUTO",
    "teamsModelTier": "AUTO"
  }
}

Changes

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