Skip to main content

Get user subscription topic

Fetch user preferences for a specific subscription topic.

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

Method: GET

PATH PARAMS

user_idstringrequired
A unique identifier associated with the user whose preferences you wish to retrieve.
topic_idstringrequired
A unique identifier associated with a subscription topic.
RESPONSES:

status: 200 OK

topicobject
The Preferences associated with the user_id for a particular subscription topic.
+ Show Properties

status: 404 Not Found

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/users/example_user_id/preferences/FW0YU64P4TMYKMMHH67D6FENX8VS \
--header 'Accept: application/json'
Responses Example
{
"topic": {
"default_status": "OPT_IN",
"has_custom_routing": true,
"custom_routing": [
"email"
],
"status": "OPTED_OUT",
"topic_id": "FW0YU64P4TMYKMMHH67D6FENX8VS",
"topic_name": "Invitations"
}
}
{
"message": "Not Found",
"type": "invalid_request_error"
}

Example‚Äč

Method: GET

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

Was this helpful?