Referral Settings object

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

Referral settings are the configuration for an account’s referral program.

status

enum<string>

The status of the referral program.

Available options:

active,

inactive

Example:

"active"

sender_reward

object

The reward that will be issued to a customer who successfully refers another individual to the loyalty program.

Show child attributes

receiver_reward

object

The reward that will be issued to an individual who is referred to and joins the loyalty program.

Show child attributes

REST API

API resources