Skip to main content
POST
Create a code batch

Authorizations

Authorization
string
header
required

API key from the Rigaly dashboard: Authorization: Bearer rgly_sk_...

Body

application/json
name
string
required
Maximum string length: 100
Example:

"Summer 2027 bottles"

points
integer
required

Points each code awards when claimed

Required range: x >= 1
Example:

250

quantity
integer
required
Required range: 1 <= x <= 32768
Example:

30000

expires_at
string<date-time>
required
Example:

"2027-12-31T23:59:59Z"

prefix
string | null

Cosmetic print prefix

Pattern: ^[A-Z0-9]{1,10}$
Example:

"SUMMER"

Response

Batch created

success
boolean
Example:

true

message
string
data
object