Skip to main content
PUT
/
api
/
user
/
notification-preferences
Update notification preferences
curl --request PUT \
  --url https://your-instance.example.com/api/user/notification-preferences \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "notificationPreferences": {
    "aiResponses": true,
    "escalations": true,
    "assignments": true,
    "calls": false,
    "campaigns": true,
    "other": false
  }
}
'
{
  "success": true,
  "message": "Notification preferences updated successfully",
  "data": {
    "aiResponses": true,
    "inboundInAutopilot": false,
    "automationTriggers": true,
    "emailSync": true,
    "escalations": true,
    "autopilotMonitor": false,
    "humanMonitor": true,
    "assignments": true,
    "calls": true,
    "campaigns": true,
    "other": true
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
notificationPreferences
object
required

Per-category notification toggles (aiResponses, automationTriggers, escalations, calls, etc.). See UserNotificationPreferences.

Response

Notification preferences updated

Returned after PUT /api/user/notification-preferences.

​
success
enum<boolean>
required
Available options:
true
​
data
object
required
Example:
{
  "aiResponses": true,
  "inboundInAutopilot": true,
  "automationTriggers": false,
  "emailSync": true,
  "escalations": true,
  "autopilotMonitor": false,
  "humanMonitor": true,
  "assignments": true,
  "calls": false,
  "campaigns": true,
  "other": false
}
​
message
string