User Notifications (notifications/v1)

Mark multiple notifications read or unread

Early Access Request Access To User Notifications API v1

Sets the read state on every notification matching the supplied filter query parameters. Accepts the same filter parameters as the list endpoint (except include, which is a list-only partial-response selector). The request body sets the target read state to apply.

patch/notifications/v1/user-notifications:mark-all

Query parameters

readstring

Filter a collection by a string search

Scope the update to notifications with the given read state. Accepts true or false. Combine with a body of { "read": true } to mark all currently-unread notifications as read (or vice versa).

severitystring[]

Filter a collection by a string search for one or more values

Filter notifications by severity. Pass the parameter multiple times to match any of the given values (?severity=CRITICAL&severity=WARN). A notification matches if its severity equals any of the listed values.

resource.typestring[]

Filter a collection by a string search for one or more values

Filter notifications by the Confluent Cloud resource type they relate to. Pass the parameter multiple times to match any of the given values (?resource.type=CLUSTER&resource.type=CONNECTOR). A notification matches if its resource.type equals any of the listed values.

resource.crnstring[]

Filter a collection by a string search for one or more values

Filter notifications by the CRN of the Confluent Cloud resource they relate to. Pass the parameter multiple times to match any of the given CRNs; a notification matches if its resource.crn equals any of the listed values.

searchstring

Filter a collection by a string search

Free-text partial-match search across the embedded notification type's display_name and description.

time_rangestring

Filter a collection by a string search

Filter notifications by a preset time window relative to now. Allowed values: PAST_24H (last 24 hours), PAST_7D (last 7 days), PAST_30D (last 30 days).

Request body

readboolean required

The target read state to apply to all notifications matching the filter query parameters. true marks them as read; false marks them as unread.

Example request

{
  "read": true
}

Response

Notifications updated successfully.

Changes

No recorded changes to this endpoint across all 1 revision of this API.