Skip to main content

Get user's preferences

Fetch all user preferences.

URL: https://api.courier.com/users/:user_id/preferences

Method: GET

PATH PARAMS

user_idstringrequired
A unique identifier associated with the user whose preferences you wish to retrieve.
RESPONSE:

status: 200 OK

pagingobject
+ Show Properties
itemsarray
The Preferences associated with the user_id.
+ Show Properties
Request Example
curl --request GET \
--url https://api.courier.com/users/example_user_id/preferences \
--header 'Accept: application/json'
Responses Example
{
"paging": {
"cursor": "MTU4OTQ5NTI1ODY4NywxLTVlYmRjNWRhLTEwODZlYWFjMWRmMjEwMTNjM2I0ZjVhMA==",
"more": true
},
"items": [
{
"default_status": "OPT_IN",
"has_custom_routing": true,
"custom_routing": [
"email"
],
"status": "OPTED_OUT",
"topic_id": "FW0YU64P4TMYKMMHH67D6FENX8VS",
"topic_name": "Invitations"
}
]
}

Example‚Äč

Method: GET

URL: https://api.courier.com/users/example_user_id/preferences

Was this helpful?