Skip to main content
GET
/
partner
/
users
/
:id
/
communication_settings
curl https://api.thanxsandbox.com/partner/users/:id/communication_settings \
  -X GET \
  -H 'X-ClientId: {client_id}' \
  -H 'Accept-Version: v4.0' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access_token}' \

{
  "communication_setting": {
    "id": "weori234098",
    "merchant_id": "owierywtwt",
    "merchant_handle": "example-merchant",
    "user_id": "woeruijsfwer",
    "reward_progress": {
      "email": true
    },
    "reward_offer": {
      "notification": true,
      "email": true
    },
    "marketing_general": {
      "email": true,
      "sms":false
    }
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.thanx.com/llms.txt

Use this file to discover all available pages before exploring further.

Scopes: users.read, communication_settings.read

​
Parameters

​
id
string
required
User ID
​
merchant_id
string
required
Merchant ID

​
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_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/partner/users/:id/communication_settings \
  -X GET \
  -H 'X-ClientId: {client_id}' \
  -H 'Accept-Version: v4.0' \
  -H 'Content-Type: application/json' \
  -H 'Authorization: Bearer {access_token}' \

{
  "communication_setting": {
    "id": "weori234098",
    "merchant_id": "owierywtwt",
    "merchant_handle": "example-merchant",
    "user_id": "woeruijsfwer",
    "reward_progress": {
      "email": true
    },
    "reward_offer": {
      "notification": true,
      "email": true
    },
    "marketing_general": {
      "email": true,
      "sms":false
    }
  }
}