Redeem invite code

POST

/api/v1/beta/codes/redeem

• Production
• Local development

Redeem an invite code during signup. Public, rate-limited.

Authorizations

• ApiKeyAuth

Request Body ^required

Request body for redeeming an invite code.

Attributes: code: The invite code string to redeem.

object

code

required

Invite code to redeem

string

>= 1 characters

Responses

200

Successful Response

Response body after attempting to redeem an invite code.

Attributes: valid: Whether the code was successfully redeemed. credit_limit: Credits provisioned (only present if valid). reason: Why redemption failed (only present if invalid).

object

credit_limit

Any of:

integer

integer

null

null

reason

Any of:

string

string

null

null

valid

required

boolean

422

Validation Error

object

detail

Array<object>

object

ctx

object

input

loc

required

Array

msg

required

string

type

required

string