Skip to main content
PATCH
/
communication_settings
/
:id
curl https://api.thanxsandbox.com/communication_settings/550e8400-e29b-41d4-a716-446655440000 \
  -X PATCH \
  -H "Content-Type: application/json"  \
  -H "Accept-Version: v4.0" \
  -H "Accept: application/json" \
  -H "X-ClientId: ${client_id}"
  -d '{
    "communication_setting": {
      "reward_earned": {
        "notification": false,
        "email": false
      },
      "feedback_available": {
        "notification": true
      },
      "marketing_general": {
        "email": true,
        "sms": false
      }
    }
  }'

{
  "communication_setting": {
    "id": "weoruoisdhf",
    "merchant_id": "owierywtwt",
    "merchant_handle": "example-merchant",
    "user_id": "woerushfwe",
    "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

​
id
string
The ID of the settings record. Can be either a UID (SecureRandom.uuid) for unauthenticated access or an ID for authenticated access.
​
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

​
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

​
Authentication

This endpoint supports two authentication modes:
  • Unauthenticated: Use the setting’s UID to update preferences without authentication
  • Authenticated: Use the setting’s hashid with OAuth bearer token for authenticated access
curl https://api.thanxsandbox.com/communication_settings/550e8400-e29b-41d4-a716-446655440000 \
  -X PATCH \
  -H "Content-Type: application/json"  \
  -H "Accept-Version: v4.0" \
  -H "Accept: application/json" \
  -H "X-ClientId: ${client_id}"
  -d '{
    "communication_setting": {
      "reward_earned": {
        "notification": false,
        "email": false
      },
      "feedback_available": {
        "notification": true
      },
      "marketing_general": {
        "email": true,
        "sms": false
      }
    }
  }'

{
  "communication_setting": {
    "id": "weoruoisdhf",
    "merchant_id": "owierywtwt",
    "merchant_handle": "example-merchant",
    "user_id": "woerushfwe",
    "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
    }
  }
}