Skip to content

SettingsController_patch

PATCH
/api/notifications/settings
curl --request PATCH \
--url https://api.streams.chat/api/notifications/settings \
--header 'Content-Type: application/json' \
--data '{ "channels": { "mobile": { "enabled": true } }, "availability": { "enabled": true, "timeZone": "example", "days": [ 1 ], "start": "example", "end": "example" }, "defaults": { "stream": { "channels": { "mobile": { "main": "all", "sessions": "all" } }, "until": null }, "dm": { "channels": { "mobile": { "main": "all", "sessions": "all" } }, "until": null } }, "overrides": { "additionalProperty": { "channels": { "mobile": { "main": "all", "sessions": "all" } }, "until": null } }, "vips": { "additionalProperty": { "bypass": true } }, "sound": "shake-bottle-pop", "mobilePush": { "when": "immediately", "alwaysFor": [ "mentions" ] } }'
levels
string
Media typeapplication/json
object
channels
object
mobile
object
enabled
required
boolean
availability
object
enabled
required
boolean
timeZone
required
string
days
required
Array<integer>
<= 7 items
start
required
string
/^([01]\d|2[0-3]):[0-5]\d$/
end
required
string
/^([01]\d|2[0-3]):[0-5]\d$/
defaults
object
stream
object
channels
required
object
mobile
object
main
required
string
Allowed values: all mentions none
sessions
required
string
Allowed values: all mentions none
until
string format: date-time
nullable /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
dm
object
channels
required
object
mobile
object
main
required
string
Allowed values: all mentions none
sessions
required
string
Allowed values: all mentions none
until
string format: date-time
nullable /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
overrides
object
key
additional properties
object
channels
required
object
mobile
object
main
required
string
Allowed values: all mentions none
sessions
required
string
Allowed values: all mentions none
until
string format: date-time
nullable /^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
vips
object
key
additional properties
object
bypass
required
boolean
sound
string
Allowed values: shake-bottle-pop boing bubble-pop bubble-pop-quick bubbles-pop doodoodoo doodoodoo-reverb high-pitch-ping light-double-clicks mhm music-note oooh quack store-door-opening throw-boing uhoh water-drop wow
mobilePush
object
when
required
string
Allowed values: immediately inactive 1m 2m 5m 10m
alwaysFor
required
Array<string>
<= 4 items
Allowed values: mentions dms requests replies