Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-262861121.0 KB

Create an invitation or referral link with an optional credit amount.

post/invitations/create

Request body

type'invitation' | 'referralLink'

Either "invitation" or "referralLink". Defaults to "invitation".

amountnumber

Credit amount to include with the invitation. Must be non-negative. Ignored for referral links (always 0).

currencystring

Currency for the amount. Required if amount > 0.

recipientNamestring

Name of the invitation recipient.

issuerNamestring

Name of the person sending the invitation.

issuerNotestring

Personal note to include with the invitation.

Response

Invitation created

insertIdstring required

Database ID of the created invitation.

redeemCodestring required

Unique code the recipient uses to redeem the invitation.

urlstring uri required

Full URL to share with the recipient.

type'invitation' | 'referralLink' required

The invitation type.

amountnumber required

Credit amount attached to this invitation.

currencystring nullable required

Currency of the amount, or null if amount is 0.