Skip to content
em sa em sa

Update Channel Preferences

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

Update notification channel preferences for the current user.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
ChannelPrefsRequest
object
in_app
Any of:
boolean
slack
Any of:
boolean
push
Any of:
boolean
Example generated
{
  "in_app": true,
  "slack": true,
  "push": true
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful Response

Media type application/json
ChannelPrefsResponse
object
in_app
required
In App
boolean
slack
required
Slack
boolean
push
required
Push
boolean
Example generated
{
  "in_app": true,
  "slack": true,
  "push": true
}

422

Section titled “422 ”

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": {}
    }
  ]
}