LogoLogo
  • Overview
    • About
    • Integrations
      • Perkville API
      • Partners
      • Integrating Perkville
        • API requirements
        • Automating your program using Perkville's API
        • Integrating Your Mobile App with Perkville
          • Page to initiate the PKCE flow.
          • Joining the loyalty program
          • Referral page
            • Referred prospects
          • Point history page
          • Earning rules page
          • Rewards page
            • Redeem confirmation page
          • Vouchers page
            • Mark voucher used confirmation page
          • Challenges page
            • Challenge details page
      • Integration Reference
        • ABC Ignite
          • ABC Ignite Engagement app
            • Home screen
            • Intro page
            • Authorize ABC Fitness page
            • Points page
            • Earning page
            • Rewards page
              • Redeem reward
              • Reward voucher
            • Referral page
        • Mariana Tek
        • Shopify
    • Security
  • Features
    • Loyalty program rules
      • Earning rules
        • Join
        • Birthday
        • Custom
        • Referral
          • Referral offer
          • Completing a referral
          • Referral flow
            • 1. Share referral offer
            • 2.Receive referral offer
            • 3. View offer details
            • 4. Claim offer
            • 5. Receive voucher
            • 6. Earn points for completed referral
        • Twitter (X)
        • Activities
      • Redeeming rules
        • Custom rewards
        • External rewards
    • Promotions
      • Frequency bonus
        • For customers: How a monthly/weekly bonus works
      • Time bonus
      • Promotion bonus
    • Challenges
      • Creating a challenge
    • Emails
      • Invitations
      • Point earning notification
      • Weekly summary
      • Redemption
      • Challenge emails
        • Challenge invitation
        • Challenge progress notification
    • Managing customers
      • Referrals
      • Customer profile
        • Managing customer emails
        • Program Status
        • Ad-hoc points, redemptions, and adjustments
        • Transfer account data
        • Voiding transactions
        • Perkville email subscription status
        • Reversing a user's Perkville account closure
      • Bulk point updates
        • Add / Redeem page
        • CSV upload
      • Inviting customers
      • Export customer list
    • Settings
      • Advanced
        • Agreements
        • Allowed registration URLs
        • Business dashboard message section
        • Integration platform
        • Join restriction
        • Membership settings
        • Prohibit staff from earning or redeeming points
        • Referral offer claim options
      • Advertising
      • Business info
      • Branding
        • Branding step 1: logo and colors
        • Branding step 2: web pages and emails
        • Setting up a custom branded domain
        • Setting up custom branded emails
      • Challenges
        • Global Challenge Settings
        • Challenge Settings
        • Challenge Progress Activities
        • Challenge Rewards
        • Challenge Invitations
      • Locations
      • Prohibit Customers
      • Staff members
      • Redeeming options
    • Vouchers
    • Reports
      • Customer list export with points
      • Challenge Overview
      • Points By Location
      • Redemption Details
      • Redemption Overview
      • Referral Details
      • Referral Overview
      • Registration Rate Overview
    • Agency
      • Ad terms
      • Suppressions
      • Advertisers
      • Images
      • Creatives
      • Campaigns
      • Obtaining business approval
  • FAQs
    • End customer FAQs
      • I'm unable to join a business' loyalty program. What should I do?
      • Freeing up your Gmail address if you accidentally created a duplicate account
    • Miscellaneous
      • Protecting against password reuse
      • Is it possible to pre-populate the email address field on the page for joining the reward program?
      • I need to change the support email that displays in the footer. How can I do that?
      • I would like to reactivate my business' Perkville account.
      • How do I control my email notifications?
      • How do I update my billing information (e.g. credit card on file)?
    • Onboarding
      • Can Perkville migrate data from other loyalty / rewards software platforms?
      • Is it possible to invite customers with a link in our own emails rather than through Perkville?
      • The reward images that I added look blurry. How can I fix this?
    • Managing emails and names
      • Can you merge two emails into the same account?
      • I would like to correct an email on an account. How do you do that?
      • Can I change which email my customer receives their notifications?
      • Can I remove an email address from a customer's account?
      • Can you change the name of a customer?
      • My customer has two accounts. What should I do?
      • How Do I Change the Email That I Use to Log in to Perkville?
      • My customer does not want to receive emails every time. What should I do?
      • How do I reset my password?
      • Answering "How can I deactivate my Perkville points account?"
    • Points
      • My customer's points are being expired. Why?
      • My customer is missing points. What should I do?
      • How do we add points to a customer or member account?
      • Can you reactivate points that expired?
    • Redemptions
      • A customer accidentally redeemed a reward. What should I do?
    • Referrals
      • Can you reward a customer for referring their friend?
      • Do referral offers expire and if so, is the referral notified?
      • I don't want customers to automatically get referral points. I want to manually complete referrals.
      • Referral submission error for front desk staff
      • How do I check if a referral has been submitted and its status?
Powered by GitBook
LogoLogo
On this page

Was this helpful?

  1. Overview
  2. Integrations
  3. Integrating Perkville
  4. Integrating Your Mobile App with Perkville

Referral page

PreviousJoining the loyalty programNextReferred prospects

Last updated 5 months ago

Was this helpful?

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

2. Get the Referral Offer URL

3. Submit Referrals on Behalf of Members

The details of the referral offer are accessible via the . 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 .

The provides the referral_offer_url that members will share.

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

Promotion endpoint
Connection's home location
Connection endpoint
Referrals endpoint