Skip to content
UltimateTeam.ai Docs

Generate invite codes

POST
/api/v1/beta/codes/generate
curl --request POST \
  --url https://api.ultimateteam.ai/api/v1/beta/codes/generate \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <X-API-Key>' \
  --data '{ "count": 1, "credit_limit": 5000, "expires_in_days": 30 }'

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

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
GenerateCodesRequest

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
Count

Number of codes to generate

integer
default: 1 >= 1 <= 100
credit_limit
Credit Limit

Credits per redeemed code

integer
default: 5000 >= 1000 <= 100000
expires_in_days
Expires In Days

Days until codes expire

integer
default: 30 >= 1 <= 365

Responses

Section titled “ Responses ”

201

Section titled “201”

Successful Response

Media typeapplication/json
GenerateCodesResponse

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
Batch Id
string
codes
required
Codes
Array<string>
credit_limit
required
Credit Limit
integer
expires_at
required
Expires At
string
Examplegenerated
{
  "batch_id": "example",
  "codes": [
    "example"
  ],
  "credit_limit": 1,
  "expires_at": "example"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}