Get Communication Setting by 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
    }
  }
}

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

string

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

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 a loyalty reward

Show reward_earned

boolean

app notification setting

boolean

email setting

hash

Settings for when a user has an unused reward

Show reward_unused

boolean

app notification setting

boolean

email setting

hash

Settings for when a user earns loyalty progress

Show reward_progress

boolean

app notification setting

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 user has the opportunity to leave feedback for a purchase

Show feedback_available

boolean

app notification setting

hash

Settings for when a merchant sends general marketing

Show marketing_general

boolean

email setting

boolean

SMS setting

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

Get Communication Settings Update Communication Settings

⌘I

Consumer API

Reference

Get Communication Setting by UID

Parameters

Response

​Parameters

​Response

Parameters

Response