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.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
A referral code captured from the URL, offered up by a newly signed-up user.
The referral code as captured. Trimmed and normalized server-side.
1 - 64Response
Successful Response
The outcome of a claim.
Always 200. A code that does not apply — a reload, an existing customer
clicking a colleague's link — reports attributed: false rather than an
error, because none of those are failures worth alarming a new user about.