Skip to main content
GET
/
communication_settings
/
:uid
curl https://api.thanxsandbox.com/communication_settings/4235d6d0-2698-4b27-aece-55c204d9aaab \
  -X GET

{
  "communication_setting": {
    "id": "weori234098",
    "merchant_id": "owierywtwt",
    "merchant_handle": "example-merchant",
    "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,
      "sms": true
    }
  }
}

​
Parameters

​
uid
string
The UID of the communication setting record (e.g., 4235d6d0-2698-4b27-aece-55c204d9aaab)

​
Response

​
id
string
The ID of the settings record
​
merchant_id
string
The ID of the merchant
​
merchant_handle
string
The handle 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/4235d6d0-2698-4b27-aece-55c204d9aaab \
  -X GET

{
  "communication_setting": {
    "id": "weori234098",
    "merchant_id": "owierywtwt",
    "merchant_handle": "example-merchant",
    "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,
      "sms": true
    }
  }
}