Skip to content
Bottle

Create a sign-up code

POST
/console/signup-codes
curl --request POST \
  --url https://example.com/console/signup-codes \
  --header 'Content-Type: application/json' \
  --cookie bottle.session_token=<bottle.session_token> \
  --data '{ "code": "example", "maxUses": 1, "expiresAt": "2026-04-15T12:00:00Z", "note": "example" }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
code
required
string
>= 6 characters <= 40 characters /^[\w-]+$/
maxUses
integer
default: 1 >= 1 <= 10000
expiresAt
string | null format: date-time
note
string | null
<= 200 characters

Responses

Section titled “Responses”

201

Section titled “201”

Created

Media typeapplication/json
object
code
required
string
note
required
string | null
maxUses
required
integer
usedCount
required
integer
expiresAt
required
string | null format: date-time
createdAt
required
string format: date-time
Examplegenerated
{
  "code": "example",
  "note": "example",
  "maxUses": 1,
  "usedCount": 1,
  "expiresAt": "2026-04-15T12:00:00Z",
  "createdAt": "2026-04-15T12:00:00Z"
}

401

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

403

Section titled “403”

Not Bottle staff, no two-step sign-in, or a console role too low for this

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

409

Section titled “409”

A code with that name exists

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

422

Section titled “422”

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string
Example
{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}