Referral page

Creating a referral page for your mobile app involves using several Perkville API endpoints. Below are the components you'll need to consider when building your referral page.

1. Retrieve Referral Offer Details

The details of the referral offer are accessible via the Promotion endpoint. This endpoint will provide you with the information about the offers available for sharing, which can be displayed on your referral page. Promotions are location specific. Therefore, you will want to filter this endpoint based on the customer's currently selected location using the locationparameter. If your app does not support selecting a location then you may use a Connection's home location.

2. Get the Referral Offer URL

The Connection endpoint provides the referral_offer_url that members will share.

3. Submit Referrals on Behalf of Members

If you want to submit referrals on behalf of members, you can do so using the Referrals endpoint. At the bottom of the referral page, you can include a form that captures necessary information for submitting a referral.