Skip to main content

PUT /users/:user_id/preferences/:topic_id

PATCHhttps://api.courier.com/users/:user_id/preferences/:topic_id
Update or Create user preferences for a specific subscription topic
PATH PARAMS
user_idstringrequired
A unique identifier associated with the user whose preferences you wish to update.
topic_idstringrequired
A unique identifier associated with a subscription topic.
BODY PARAM
custom_routingarray
The Channels a user has chosen to receive notifications through for this topic
statusstring
The preference status the user has set for a subscription topic.
Responses
AUTH TOKEN
curl --request PATCH \
--url https://api.courier.com/users/example_user_id/preferences/FW0YU64P4TMYKMMHH67D6FENX8VS \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '
{
"status": "OPTED_OUT"
}
'
Response Example
{
"status": "SUCCESS"
}

Method: PUT

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

JSON
// Sample User Preference Input
{
"topic": {"status":"OPTED_OUT", "custom_routing": ["sms", "push"]}
}