POST/api/v2/vouchers/batch

POST /api/v2/vouchers/batch

Authentication

Send your API key in the x-api-key header on every request.

Parameters

Request parameters
Field	Type	Required	Description
Idempotency-Key (header)	string	No

Request body

application/json

Request body fields
Field	Type	Required
Count	unknown	No
SharedCode	boolean	No
Name	string	Yes
Description	string	No
GroupPublicId	string (uuid)	No
TargetUserId	unknown	No
CustomCode	string	No
Prefix	string	No
Type	string	No
Value	unknown	No
Currency	string	No
PerUserLimit	unknown	No
MaximumTotalUses	unknown	No
MaximumAggregateValue	unknown	No
RequiresWhitelabelApproval	boolean	No
RequiresEmail2Fa	boolean	No
ValidFrom	string (date-time)	No
ValidUntil	string (date-time)	No
InitialStatus	string	No
ExternalReference	string	No
AcceptUnboundedLiability	boolean	No

Responses

200 — OK

Response 200 fields
Field	Type	Required
Id	string (uuid)	Yes
Kind	string	Yes
Status	string	Yes
TotalItems	unknown	Yes
SuccessfulItems	unknown	Yes
FailedItems	unknown	Yes
CreatedAt	string (date-time)	Yes
CompletedAt	string (date-time)	Yes

Example request

curl -X POST "https://{base_url}/api/v2/vouchers/batch" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"Name":"…"}'

This page is generated from the live OpenAPI specification and always matches the current API.