Notifications

Update Notification Preferences

Enables or disables event-channel pairs. Only the pairs sent are changed; the response is the full matrix. Send {"action":"restore_defaults"} to reset all preferences to their defaults.

put/notifications/preferences

Request

Base URL
https://api-v2.pandavideo.com.br
URL
https://api-v2.pandavideo.com.br/notifications/preferences
Auth
API key in header Authorization

Request body

action'restore_defaults'

Send restore_defaults (without preferences) to reset all preferences to their defaults.

Example request

{
  "preferences": [
    {
      "event_type": "VIDEO_READY",
      "channel": "EMAIL",
      "enabled": true
    },
    {
      "event_type": "BILLING_FAILED",
      "channel": "DASHBOARD",
      "enabled": false
    }
  ]
}

Response

Updated preference matrix

Example response

{
  "preferences": [
    {
      "event_type": "VIDEO_READY",
      "category": "VIDEO",
      "channel": "EMAIL",
      "enabled": true,
      "mandatory": false,
      "available": true,
      "default_enabled": false
    },
    {
      "event_type": "BILLING_FAILED",
      "category": "BILLING_ACCOUNT",
      "channel": "DASHBOARD",
      "enabled": false,
      "mandatory": false,
      "available": true,
      "default_enabled": true
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.