referral

Claim a referral code

Attribute the caller's workspace to a referral code and pay the signup rewards. Safe to call repeatedly and never an error: a code that does not apply reports attributed: false. Requires a signed-in user rather than an API key: the claim records who signed up, and an API key has no person behind it.

post/referral/claim/

Request

  • Base URL: https://api.getoneprofile.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.getoneprofile.ai/referral/claim/
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Request body

codestring required

The referral code as captured. Trimmed and normalized server-side.

sourcestring nullable

The affiliate's own tag for where the link was shared, banked at click time by the link redirect. Absent for a link followed any other way. Narrowed rather than validated server-side: an unrecognized value becomes untagged rather than failing a claim.

Response

Successful Response

attributedboolean required

Whether the code was recorded against this workspace.

credits_on_upgradeinteger required

Whole credits this workspace will receive when it starts a paid plan; 0 when nothing was attributed. Signing up pays nothing, so this is the promise the welcome message makes.

referrer_namestring nullable required

The workspace that invited them, for the welcome message.

Changes

No recorded changes to this operation across all 1 revision of this API.