Communication Settings
Update User's Communication Settings
Communication Settings
Update User's Communication Settings
This endpoint allows the update of a user's notification / email settings for the specified merchant.
PATCH
/users/:id/communication_settings
Bearer*
Scopes: users.write, communication_settings.write
Parameters
merchant_idrequired
string
Merchant ID
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
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
curl https://api.thanxsandbox.com/users/woerihfslkwer/communication_settings?merchant_id=owierywtwt \
-X PATCH \
$AUTH_HEADERS
-d '{
"communication_setting": {
"reward_progress": {
"email": false
},
"reward_offer": {
"notification": false,
"email": false
},
"marketing_general": {
"email": false
}
}
}'
{
"communication_setting": {
"id": "weoruoisdhf",
"merchant_id": "owierywtwt",
"user_id": "woerushfwe",
"reward_progress": {
"email": true
},
"reward_offer": {
"notification": true,
"email": true
},
"marketing_general": {
"email": true
}
}
}
curl https://api.thanxsandbox.com/users/woerihfslkwer/communication_settings?merchant_id=owierywtwt \
-X PATCH \
$AUTH_HEADERS
-d '{
"communication_setting": {
"reward_progress": {
"email": false
},
"reward_offer": {
"notification": false,
"email": false
},
"marketing_general": {
"email": false
}
}
}'
{
"communication_setting": {
"id": "weoruoisdhf",
"merchant_id": "owierywtwt",
"user_id": "woerushfwe",
"reward_progress": {
"email": true
},
"reward_offer": {
"notification": true,
"email": true
},
"marketing_general": {
"email": true
}
}
}