Skip to content

Update channel preferences (including email digest frequency)

PUT
/api/canvas/notifications/preferences/channels
curl --request PUT \
--url https://example.com/api/canvas/notifications/preferences/channels \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "in_app": true, "slack": true, "push": true, "email_digest": "off" }'

Update notification channel preferences for the current user.

Supports partial updates — only provided fields are changed. Valid email_digest values: off, instant, daily, weekly.

Media type application/json
ChannelPreferencesRequest
object
in_app
Any of:
boolean
slack
Any of:
boolean
push
Any of:
boolean
email_digest
Any of:
string
Allowed values: off instant daily weekly

Successful Response

Media type application/json
Example generated
example

Validation Error

Media type application/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Example generated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example",
"input": "example",
"ctx": {}
}
]
}