Skip to main content
GET
/
recipients
/
{recipient_id}
/
preferences
List preferences for a recipient
curl --request GET \
  --url https://api.example.com/recipients/{recipient_id}/preferences \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "preferences": [
      {
        "target": {
          "channel": "posts",
          "topic": "any",
          "event": "new_comment",
          "label": "Comments on your posts"
        },
        "state": {
          "enabled": true,
          "inherited": true
        }
      },
      {
        "target": {
          "channel": "announcements",
          "topic": "none",
          "event": "new_feature",
          "label": "Product Announcements"
        },
        "state": {
          "enabled": false,
          "inherited": false
        }
      }
    ]
  }
}
These are the project preferences (global-level) of the recipient. To create project preferences go to Bodhveda Console > Preferences. 💡 You should show these preferences on your “Notification’s setting” screen where the recipient can see their current preferences and update them. 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.

Response

200 - application/json

List of recipient's preferences.