Skip to main content
POST
Generate a referral code for a customer

Body Parameters

Example Request

Response

Response Fields

Notes

  • Each customer can have one active referral code at a time. Calling this endpoint again for the same customer returns the existing code.
  • The referral code is case-insensitive when redeemed but is returned in uppercase for consistency.
  • When a new customer signs up using the referral URL, a referral record is automatically created linking the referrer to the new customer.
  • To invalidate a referral code, contact support or use the dashboard.
Embed the url field directly into email campaigns or share buttons to make referrals seamless for your customers.

Authorizations

Authorization
string
header
required

Tenant API key obtained from POST /auth/register or POST /v1/developer/keys.

Body

application/json
customer_id
string<uuid>
required

Response

The customer's referral code.

data
object