Skip to main content

GET /preferences/:recipient_id

URL: https://api.courier.com/preferences/:recipient_id

Method: GET

Path Parameters

recipient_idstringrequired
A unique identifier representing the recipient associated with the requested profile.

Responses

status: 200 OK

notificationsrecord
json object that contains notification ids with the respective preferences
+ Show Properties
categoriesrecord
json object that contains category ids with the respective preferences
+ Show Properties

status: 400 Bad Request

messagestring
A message describing the error that occurred.
typestring
[invalid_request_error] The type of error that occurred.

Request Example

curl --request GET \
--url https://api.courier.com/preferences/0460766e-8463-4905-ae98-b72c7aef41d6 \
--header 'Accept: application/json'

Responses 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"
}
}
}
{
"message": "Error Message",
"type": "invalid_request_error"
}
Was this helpful?