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.

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

Enables or disables event-channel pairs. Only the pairs sent are changed; the response is the full matrix (same format as the GET).

Request body

Send a preferences array with the pairs to update:

{
  "preferences": [
    { "event_type": "CAPTIONS_READY", "channel": "EMAIL", "enabled": true },
    { "event_type": "BILLING_FAILED", "channel": "SMS", "enabled": true }
  ]
}

Each item requires event_type, channel and enabled.

Restore defaults

To reset all preferences to their default values, send:

{ "action": "restore_defaults" }

Do not include preferences when using action.

Errors

Error codeCause
CHANNEL_UNAVAILABLEThe channel is not available for this event (e.g. SMS for a VIDEO event). The detail field shows the pair.
INVALID_PREFERENCEUnknown event type or channel name.
CONFLICTING_PREFERENCESame event-channel pair sent with different enabled values, or conflicting 85%/100% bandwidth/storage preferences.
BadRequestpreferences is not an array, or enabled is not a boolean.

Example error

{ "errCode": "CHANNEL_UNAVAILABLE", "errMsg": "channel is not available for this event.",
  "detail": "event_type=VIDEO_READY channel=SMS" }
⚠️

Bandwidth and storage 85% alerts (BANDWIDTH_NEAR_LIMIT, STORAGE_NEAR_LIMIT) follow the preference of the 100% alert. Sending both with different values returns CONFLICTING_PREFERENCE.

Body Params
preferences
array of objects

Pairs to update. Only the pairs sent are changed.

preferences
string
enum

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

Allowed:
Responses

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