Get referral settings

JavaScript

Smile.referralSettings.get().then(
  (referralSettings) => {
    if (referralSettings) {
      // Handle the referral settings object
    } else {
      // No active referral program
    }
  }
);

JavaScript

Smile.referralSettings.get().then(
  (referralSettings) => {
    if (referralSettings) {
      // Handle the referral settings object
    } else {
      // No active referral program
    }
  }
);

This async method retrieves the configuration for the account’s referral program. This method always makes an API call to fetch the latest data.

For the best performance, we suggest preloading referral settings and then using the Smile.referralSettings.preloaded() method.

Returns

This method returns a Promise that:

On success, resolves with either a referral settings object or null if there is no active referral program.
On failure, rejects with an error object.

If the method is improperly invoked, the Promise will be rejected.

Referral Settings object

Preloaded referral settings

⌘I

Key concepts

Smile object

SDK resources

Returns

​Returns

Returns