Skip to content

Get notification preferences

GET
/api/canvas/notifications/preferences
curl --request GET \
--url https://example.com/api/canvas/notifications/preferences \
--header 'Authorization: Bearer <token>'

Get the current user’s notification mute preferences.

Successful Response

Media type application/json
PreferencesResponse
object
user_uuid
required
User Uuid
string
global_mute
required
Global Mute
boolean
muted_deals
required
Muted Deals
Array
channels
Any of:
ChannelsResponse
object
in_app
required
In App
boolean
slack
required
Slack
boolean
push
required
Push
boolean
email_digest
required
Email Digest
string
Example generated
{
"user_uuid": "example",
"global_mute": true,
"muted_deals": [
"example"
],
"channels": {
"in_app": true,
"slack": true,
"push": true,
"email_digest": "example"
}
}