List Notification Preferences

Returns the full preference matrix for the authenticated login: 40 event-channel pairs with current and default values.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Returns the full preference matrix for the authenticated login: 40 event-channel pairs with current value, default value and availability.

Response fields

FieldTypeDescription
event_typestringEvent identifier (e.g. BILLING_FAILED, VIDEO_READY).
categorystringOne of BILLING_ACCOUNT, VIDEO, PANDA_AI, ACCOUNT_SECURITY.
channelstringEMAIL, SMS, WHATSAPP or DASHBOARD.
enabledbooleanWhether this pair is currently enabled for the login.
mandatorybooleanWhether this pair cannot be disabled. Currently always false.
availablebooleanWhether this channel is available for this event. VIDEO and PANDA_AI do not support SMS/WHATSAPP.
default_enabledbooleanThe default value when the login has not customized this pair.

Example response

{
  "preferences": [
    { "event_type": "BILLING_FAILED", "category": "BILLING_ACCOUNT", "channel": "EMAIL",
      "enabled": true, "mandatory": false, "available": true, "default_enabled": true },
    { "event_type": "BILLING_FAILED", "category": "BILLING_ACCOUNT", "channel": "SMS",
      "enabled": false, "mandatory": false, "available": true, "default_enabled": false },
    { "event_type": "BILLING_FAILED", "category": "BILLING_ACCOUNT", "channel": "WHATSAPP",
      "enabled": false, "mandatory": false, "available": true, "default_enabled": false },
    { "event_type": "CAPTIONS_READY", "category": "PANDA_AI", "channel": "EMAIL",
      "enabled": false, "mandatory": false, "available": true, "default_enabled": false }
  ]
}
📘

The response always contains all 40 pairs, even if the login has never changed any preference.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json