Communication Settings
Get User's Communication Settings
Communication Settings
Get User's Communication Settings
This endpoint returns a user's communication settings for the specified merchant. 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
/users/:id/communication_settings
Bearer*
curl --request GET \
--url https://api.thanx.com/users/:id/communication_settings \
--header 'Authorization: Bearer <token>' \
--data '{
"merchant_id": "<merchant_id>"
}'Scopes: users.read, communication_settings.read
Parameters
merchant_idrequired
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_progress
hash
Settings for when a user earns loyalty progress
reward_offer
hash
Settings for when a merchant sends an offer
marketing_general
hash
Settings for when a merchant sends general marketing
{
"communication_setting": {
"id": "weori234098",
"merchant_id": "owierywtwt",
"user_id": "woeruijsfwer",
"reward_progress": {
"email": true
},
"reward_offer": {
"notification": true,
"email": true
},
"marketing_general": {
"email": true
}
}
}
curl --request GET \
--url https://api.thanx.com/users/:id/communication_settings \
--header 'Authorization: Bearer <token>' \
--data '{
"merchant_id": "<merchant_id>"
}'{
"communication_setting": {
"id": "weori234098",
"merchant_id": "owierywtwt",
"user_id": "woeruijsfwer",
"reward_progress": {
"email": true
},
"reward_offer": {
"notification": true,
"email": true
},
"marketing_general": {
"email": true
}
}
}