Skip to content

Create coupon pool (draft)

Requires ADMIN.

projectId
required
string

Project (tenant) identifier. Row-level tenant isolation is enforced on every query.

Media typeapplication/json
object
name
required
string
>= 1 characters <= 120 characters
form
string
default: random
Allowed values: random generic personal
totalCount
required
integer
>= 1
codeLength
integer
default: 16 >= 8 <= 32
perUserLimit
integer
default: 1 >= 1
validityDays
integer
>= 1
benefitsJson
object
key
additional properties
any

Created pool.

Media typeapplication/json
object
pool
object
id
string
projectId
string
name
string
form
string
Allowed values: random generic personal
codeLength
integer
totalCount
integer
perUserLimit
integer
validityDays
integer | null
benefitsJson
string | null
status
string
Allowed values: draft generating active exhausted archived
createdAt
string
updatedAt
string

Missing/invalid path input (e.g. projectId) or invalid JSON body.

Media typeapplication/json
object
error
required

Human-readable error message.

string
message
string
Examplegenerated
json
{
"error": "example",
"message": "example"
}

Not authenticated (401 via requireAuthenticated) or insufficient project role (403).

Media typeapplication/json
object
error
required

Human-readable error message.

string
message
string
Examplegenerated
json
{
"error": "example",
"message": "example"
}

Zod validation failed (error=‘参数校验失败’ with issues[]).

Media typeapplication/json
object
error
required
string
issues
Array<object>
object
path
string
message
string
details
Array<object>
object
key
additional properties
any
key
additional properties
any
Example
json
{
"error": "参数校验失败"
}