Referral Links

How referral links are generated

Your app creates referral links by calling the Tolinku API:

POST /v1/api/referral/create
{
  "user_id": "user_456"
}

Tolinku generates a random 10-character code and returns the referral link:

{
  "referral_code": "ABC1234567",
  "referral_url": "https://your-app.tolinku.com/ref/ABC1234567"
}

The user can share this URL via text message, social media, email, or any other channel.

What happens when someone taps a referral link

1. The link opens in the browser.
2. If the app is installed, it opens directly via Universal Links / App Links. Your app receives the referral code from the URL.
3. If the app is not installed, the user sees a landing page (or is redirected to the store). After installing, deferred deep linking delivers the referral code to your app.
4. Your app extracts the referral code and calls the Tolinku API to mark the referral as complete (or report a milestone).

Tracking

Referral link clicks are tracked in your analytics like any other deep link. The route prefix is /ref and the token is the referral code. You can filter analytics by the ref prefix to see referral-specific traffic.

Limits

Each user can have a limited number of active referrals at once, controlled by the Max per user setting in referral setup. If a user tries to create a referral when they have reached the limit, the API returns an error.

Note

Referral codes are permanent. Even after a referral is completed or expired, the code cannot be reused. If a user already has a pending referral, calling create returns the existing code instead of generating a new one.

API reference

For full API details, see the Referrals API documentation.