Skip to content

Generate invite codes

POST
/api/v1/beta/codes/generate

Generate batch invite codes with configurable expiry and credit limit. Admin only.

Authorizations

Request Body required

Request body for generating invite codes.

Attributes: count: Number of codes to generate (1-100). expires_in_days: Days until codes expire (1-365). credit_limit: Credits to provision per redeemed code (1000-100000).

object
count

Number of codes to generate

integer
default: 1 >= 1 <= 100
credit_limit

Credits per redeemed code

integer
default: 5000 >= 1000 <= 100000
expires_in_days

Days until codes expire

integer
default: 30 >= 1 <= 365

Responses

201

Successful Response

Response body after generating invite codes.

Attributes: codes: List of generated invite code strings. batch_id: Batch identifier grouping these codes. expires_at: When these codes expire. credit_limit: Credits each code provisions on redemption.

object
batch_id
required
string
codes
required
Array<string>
credit_limit
required
integer
expires_at
required
string

422

Validation Error

object
detail
Array<object>
object
ctx
object
input
loc
required
Array
msg
required
string
type
required
string