SMsmile
Referral Settings

Get referral settings

Changed on

Retrieves the configuration for the account's referral program.

get/referral_settings

Request

  • Base URL
    https://api.smile.io/v1
  • URL
    https://api.smile.io/v1/referral_settings
  • Auth
    HTTP bearer

Response

The referral settings were successfully retrieved.

Example response

{
  "referral_settings": {
    "status": "active",
    "sender_reward": {
      "name": "$5 off discount",
      "image": {
        "url": "https://platform-images.smilecdn.co/3755938.png",
        "content_type": "image/png"
      }
    },
    "receiver_reward": {
      "name": "5% off coupon",
      "image": {
        "url": "https://platform-images.smilecdn.co/3755938.png",
        "content_type": "image/png"
      }
    }
  }
}

Changes