Admin — generate a batch of voucher codes

ADMIN

Starts an asynchronous batch that creates count new codes. Returns
immediately with the batch; poll GET /admin/vouchers/batches/{batch_id}
until status is terminal, then download the codes from result_url.

Large batches take time by design: a campaign's vouchers share one storage
partition with a fixed write ceiling, so a drop of hundreds of thousands is
paced rather than rejected.

The request is refused up front when the requested code length leaves too
little room for count distinct codes.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Creates a batch of new voucher codes. Codes use a reduced-confusion alphabet so they survive being read off a receipt or typed by hand.

uuid
required
integer
required
≥ 1
string

Prepended to every code, e.g. SUMMER-.

integer
≥ 4
Defaults to 10

Length of the random portion. Rejected when the resulting code space is too small for the requested count to stay collision-free.

string

Character set for the random portion. Duplicates are ignored. Defaults to an alphabet excluding 0, 1, I, O, L and U.

integer
≥ 1
Defaults to 1
date-time
date-time
string
string

Groups the batch. Must not already exist in the campaign. Defaults to a timestamped value when omitted.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
OAuth2
Missing 1 required scope
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json