v1

latestOpenAPI 3.0.12026-07-269671357.0 KB
Referrals

Generate a single use referral link

post/v1/referrals/{referral_campaign_id}/generate_link

Path parameters

referral_campaign_idstring required

The id of the referral campaign to generate a single use link for.

Request body

expires_atstring

ISO 8601 timestamp for when the single use code should expire. Default: 3 months from creation

Example request

{
  "expires_at": "2026-06-25T15:43:43Z"
}

Response

Success

linkstring

Single use referral link to share with the signer.