Communication Settings
Get Communication Settings
Communication Settings
Get Communication Settings
This endpoint returns a user's communication settings. The notification key reflects a user's settings for receiving push notifications in their app or via text if they don't have an app installed. The email key reflects a user's settings for receiving emails.
GET
/communication_settings
Bearer*
curl --request GET \
--url https://api.thanx.com/communication_settings \
--header 'Authorization: Bearer <token>'
Parameters
merchant_id
string
Merchant ID
Response
id
string
The ID of the settings record
merchant_id
string
The ID of the merchant
user_id
string
The ID of the user
reward_earned
hash
Settings for when a user earns a loyalty reward
reward_unused
hash
Settings for when a user has an unused reward
reward_progress
hash
Settings for when a user earns loyalty progress
reward_offer
hash
Settings for when a merchant sends an offer
feedback_available
hash
Settings for when a user has the opportunity to leave feedback for a purchase
marketing_general
hash
Settings for when a merchant sends general marketing
curl https://api.thanxsandbox.com/communication_settings/woerihfslkwer \
-X PATCH \
$AUTH_HEADERS
-d '{
"communication_settings": {
"reward_earned": {
"notification": false,
"email": false
},
"feedback_available": {
"notification": true
}
}
}'
{
"communication_settings": [
{
"id": "weori234098",
"merchant_id": "owierywtwt",
"user_id": "woeruijsfwer",
"reward_earned": {
"notification": true,
"email": true
},
"reward_unused": {
"notification": true,
"email": true
},
"reward_progress": {
"notification": true,
"email": true
},
"reward_offer": {
"notification": true,
"email": true
},
"feedback_available": {
"notification": true
},
"marketing_general": {
"email": true
}
}
]
}
curl https://api.thanxsandbox.com/communication_settings/woerihfslkwer \
-X PATCH \
$AUTH_HEADERS
-d '{
"communication_settings": {
"reward_earned": {
"notification": false,
"email": false
},
"feedback_available": {
"notification": true
}
}
}'
{
"communication_settings": [
{
"id": "weori234098",
"merchant_id": "owierywtwt",
"user_id": "woeruijsfwer",
"reward_earned": {
"notification": true,
"email": true
},
"reward_unused": {
"notification": true,
"email": true
},
"reward_progress": {
"notification": true,
"email": true
},
"reward_offer": {
"notification": true,
"email": true
},
"feedback_available": {
"notification": true
},
"marketing_general": {
"email": true
}
}
]
}