Get User's 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
    }
  }
}

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
    }
  }
}

Scopes: users.read, communication_settings.read

Parameters

string

required

User ID

string

required

Merchant ID

Response

string

The ID of the settings record

string

The ID of the merchant

string

The handle of the merchant

string

The ID of the user

hash

Settings for when a user earns loyalty progress

Show reward_progress

boolean

email setting

hash

Settings for when a merchant sends an offer

Show reward_offer

boolean

app notification setting

boolean

email setting

hash

Settings for when a merchant sends general marketing

Show marketing_general

boolean

email setting

boolean

SMS setting

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
    }
  }
}

⌘I

Merchant & Partner API

Reference

Get User's Communication Settings

Parameters

Response

​Parameters

​Response

Parameters

Response