Skip to main content
PATCH
/
recipients
/
{recipient_id}
/
notifications
{
  "updated_count": 2
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer bv_xxxxxxxxx, where bv_xxxxxxxxx is your API Key with Full access scope.

Path Parameters

​
recipient_id
string
required

Unique external identifier for the recipient.

Body

application/json
​
state
object
required

The notification state to update.

  • You can set one or multiple state fields in the same request.
  • Fields left out of state will remain unchanged.
Example:
{ "read": true }
​
ids
string[]

Array of notification IDs to update. If omitted, applies to all.

Response

200 - application/json

Successfully updated notifications

​
updated_count
integer

Number of notifications updated.