Skip to main content

Apply referral

POST 
/track/referral

Applying Referral​

This endpoint allows you to apply referrals for a user via your backend system.

Edit the Base URL in request schema for switching between regions.

Request Headers​

  • apikey: Your private API key (required for authorization)

Request Parameters​

  • uid (string, required): UUID of the user receiving the referral (must be identified first)
  • referral_code (string, optional): Referral code used. Optional for lead-added flows.

Sample Request​

{
	"uid": "2762ff09-d7f0-4288-b25d-e5ffe5434724",
	"referral_code": "nudgeQWE12"
}

Successful Response​

{
	"ref_by": "98dcec9a-b0c2-4d90-a82a-7351bd6f9f28",
	"ref_by_name": "Alice Doe",
	"props_bool": {
		"referred": true
	},
	"props_text": {
		"ref_channel": "social"
	}
}

Response Fields​

FieldTypeDescription
ref_bystringUUIDv4 of the referrer
ref_by_namestringName of the referrer
props_boolobjectBoolean properties applied to the referred user
props_textobjectText properties applied to the referred user

Rate Limits​

  • 100 requests per second

Request​

Responses​

Successful response with referral data