Skip to main content

GET /preferences/:recipient_id

GEThttps://api.courier.com/preferences/:recipient_id
Get the preferences stored under a specified recipient ID.
PATH PARAMS
recipient_idstringrequired
A unique identifier representing the recipient associated with the requested profile.
Responses
AUTH TOKEN
curl --request GET \
--url https://api.courier.com/preferences/0460766e-8463-4905-ae98-b72c7aef41d6 \
--header 'Accept: application/json'
Response Example
{
"notifications": {
"{KEY}": {
"channel_preferences": [
{
"channel": "push"
}
],
"rules": [
{
"type": "snooze"
}
],
"status": "OPTED_IN"
}
},
"categories": {
"{KEY}": {
"channel_preferences": [
{
"channel": "push"
}
],
"rules": [
{
"type": "snooze"
}
],
"status": "OPTED_IN"
}
}
}