Referral codes

Overview

This guide is designed to assist platform owners in deploying and tracking referral codes. These codes are integral to promotional campaigns, attracting new users, and providing insights into the effectiveness of marketing efforts. The document will walk you through the process of incorporating referral codes into URLs for distribution and monitoring their usage through the administrative panel. By following the outlined steps, platform owners can effectively manage and analyze referral marketing strategies.

Related pages

Persons
Companies

Prerequisites

Access to the Administrative Panel.
Feature flag registration.referral_code enabled.

Workflow

Step 1: Create a Referral Code

As a platform owner, create a referral code for a marketing campaign. For example, a campaign made in a Facebook cryptocurrency group might have the "crypto_week" code.
Incorporate the referral code into a promotional URL. The URL should be structured as follows: https://client.abc.com?referral_code=crypto_week with the crypro_week code set as the referral_code query parameter.

Step 2: Distribute the Referral URL

Send the URL containing the referral code to the moderator or administrator of the marketing platform (e.g., a Facebook group).
Ensure the advertisement or promotional message contains the URL with the referral code.

Step 3: User Registration with Referral Code

Potential clients click the referral link and are directed to the platform registration page.
The referral code is automatically populated in the registration form if the link is structured correctly. Users can enter the referral code manually if necessary.
The /api/public/register registration endpoint accepts the referral code in the referralCode field, validating it to be up to 250 characters.

Step 4: Track Referral Codes in the Admin Panel

Log in to the Admin Panel.
Navigate to Banking > Persons or Banking > Companies depending on the client type.
Filter the list by the Referral code parameter.
The list will be updated to contain only profiles with the same Referral code parameter value.
Select a profile and click Show to open its details.
Navigate to the Metadata section to access the referral code details and additional tracking parameters.

Additional Information

The logic for generating referral codes is managed by the platform owner and outside of the Crassula system. Confirm the generation process and any specific requirements with your technical team.
The presence of the referral code field in the registration process is solely controlled by the feature flag; ensure it is enabled for the code to be recognized.

Contact our support team for any further questions or assistance.