Need help applying this to your account?
Contact support and we will keep this article attached to your request.
When should I add a referrer through the API?
Use the API when your own application decides that a person should join the referral program, such as after a purchase or milestone.
Referral Factory creates the referrer in the selected campaign and generates the referral mechanism supported by that campaign.
Which endpoint creates a referrer?
Send a POST request to
https://api.referral-factory.com/api/v3/referrers and authenticate it with Authorization: Bearer YOUR_API_KEY.Check the current API documentation before implementing or changing a production request.
Which fields should I send?
The required fields are
campaign_id, first_name and email. Optional supported fields can include notify, extra_fields and promotion.Only send optional fields supported by the campaign and current API reference. Never place a real API Key in an example or front-end application.
What happens after the request?
A successful request creates the referrer in the campaign. Confirm the person appears under Referrers and that the campaign generated the expected referral link or other enabled referral mechanism.
How do I test and troubleshoot the request?
Use the real Campaign ID of a test campaign and fake person details. Send the request from a secure server, check the response and confirm the referrer in Referral Factory.
If it fails, verify the POST method, V3 referrer URL, Bearer header, JSON content type, required fields and API access. Read the response body for field-level validation errors.