Skip to main content
DELETE
/
recipients
/
{recipient_id}
/
notifications
Delete notifications
curl --request DELETE \
  --url https://api.example.com/recipients/{recipient_id}/notifications \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ids": [
    "notif_123",
    "notif_456"
  ]
}
'
{
  "deleted_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
​
ids
string[]

Array of notification IDs to delete. If omitted, all will be deleted.

Response

200 - application/json

Successfully deleted notifications

​
deleted_count
integer

Number of notifications deleted.