Skip to content
Optiwork API Docs

Set the caller's notification preferences for this board

PATCH
/boards/{board}/members/myself/notifications/preferences
curl --request PATCH \
  --url https://projects.work.optidata.cloud/api/boards/1/members/myself/notifications/preferences \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "notification_mode": "assignee", "is_notified_through_app": true, "is_notified_through_email": false }'

Updates which events on this board notify the caller (all activity, only cards where they are an assignee, only mentions, or silent) and through which channels (in-app, email). Affects only the authenticated member.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
board
required
integer

Board id.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
notification_mode
string
Allowed values: all assignee mentions silent
is_notified_through_app
boolean
is_notified_through_email
boolean
Example
{
  "notification_mode": "assignee",
  "is_notified_through_app": true,
  "is_notified_through_email": false
}

Responses

Section titled “Responses”

200

Section titled “200”

The stored preference.

Media typeapplication/json
object
notification_mode
string
Allowed values: all assignee mentions silent
is_notified_through_app
boolean
is_notified_through_email
boolean
Example
{
  "notification_mode": "assignee",
  "is_notified_through_app": true,
  "is_notified_through_email": false
}

401

Section titled “401”

Missing, invalid or expired bearer passport.

Media typeapplication/json
object
error
string
Example
{
  "error": "JWT passport exception: Missing bearer token in request"
}

403

Section titled “403”

The authenticated user lacks the required board permission.

Media typeapplication/json
object
message
string
Example
{
  "message": "This action is unauthorized."
}

404

Section titled “404”

Resource not found, or a nested resource does not belong to its parent in the path.

Media typeapplication/json
object
message
string
Example
{
  "message": "Not found."
}

422

Section titled “422”

Validation failed.

Media typeapplication/json
object
message

First validation error message.

string
errors

Map of field name → list of error messages.

object
key
additional properties
Array<string>
Example
{
  "message": "The name field is required.",
  "errors": {
    "name": [
      "The name field is required."
    ]
  }
}