POST/api/v2/admin/vouchers/rules

POST /api/v2/admin/vouchers/rules

Authentication

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

Parameters

Request parameters
FieldTypeRequiredDescription
companyId (query)unknownNo
Idempotency-Key (header)stringNo

Request body

application/json

Request body fields
FieldTypeRequiredDescription
NamestringYes
TriggerTypestringYes
CampaignModestringYes
VoucherGroupIdstring (uuid)No
SharedVoucherIdstring (uuid)No
ThresholdAmountunknownNo
ThresholdCurrencystringNo
MaximumAssignmentsunknownNo
MaximumAssignedValueunknownNo
ValidFromstring (date-time)No
ValidUntilstring (date-time)No
CriteriaunknownNo
VoucherTemplateunknownNo

Responses

200 — OK

Response 200 fields
FieldTypeRequiredDescription
Idstring (uuid)Yes
NamestringYes
TriggerTypestringYes
CampaignModestringYes
EnabledbooleanYes
AssignmentCountunknownYes
AssignedValueunknownYes

Example request

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

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