You can find our official API Documentation here 👉 Referral Factory Developer Docs
Referral Factory's API will allow you to add users to your referral program, issue them with referral links, and implement advanced referral tracking of your campaign.
Our API is organized around REST and is designed to be a predictable and intuitive interface for interacting with your referral programs and the users participating in them.
You must be on at least the Basic plan to use the Referral Factory API.
Using our API you will be able to:
👉 Add new users to your campaign, and issue them with referral links. Using the API allows you to bypass steps one and two of the campaign builder. You will need at least a ‘name’ and ‘email’ to add a user to your campaign so they can start referring.
👉 Send new referred users (invited users) to any endpoint using webhooks, zapier or an integration with your own CRM software (see our integrations here).
👉 Access all of your user records in real-time - this is the data you would usually see on your ‘Users’ tab when logged into Referral Factory.
👉 View, update, add, or delete user records.
👉 Qualify ‘referred’ users once they successfully convert (for example when they complete a desired action such as subscribing or purchasing) so you can track referrals and converted referrals of your campaign.
👉 Get notified when a reward needs to be issued to a user.
These functions will allow you to successfully scale your referral program, without having to increase the manual workload needed to manage it 👏.
Referral Factory currently does not have a test mode, so please use the API functions carefully as you will be working with real user records. Most developers use the example campaigns that are pre-populated in your dashboard for testing.
If you have any additional questions please contact our technical support team at [email protected]. Our developers are ready and on hand to help you get your referral program up and running 🧑💻🚀
Visit our 👉 API documentation to learn more.
