Skip to main content
GET
/
recipients
/
{recipient_id}
/
preferences
/
check
Check recipient's subscription state for a target
curl --request GET \
  --url https://api.example.com/recipients/{recipient_id}/preferences/check \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "target": {
      "channel": "posts",
      "topic": "post_id_123",
      "event": "new_comment"
    },
    "state": {
      "enabled": true,
      "inherited": false
    }
  }
}
💡 You could use this API to conditionally render something based on whether the recipient has subscribed to the target or not. inherited: false means the recipient has overridden the preference for that target explicitly to whatever subscribed is right now.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
recipient_id
string
required

The unique identifier of the recipient.

Query Parameters

​
channel
string
required

Channel to check.

​
topic
string
required

Topic to check.

​
event
string
required

Event to check.

Response

200 - application/json

Subscription state for the target