Skip to main content
POST
Claim a referral code

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

A referral code captured from the URL, offered up by a newly signed-up user.

code
string
required

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

Required string length: 1 - 64

Response

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.

attributed
boolean
required

Whether the code was recorded against this workspace.

credits_awarded
integer
required

Whole credits this workspace just received; 0 when nothing was granted.

referrer_name
string | null
required

The workspace that invited them, for the welcome message.