v2

latestOpenAPI 3.1.02026-08-01244220427.0 KB
Loyalty

Update Loyalty Program Voucher

Update Voucher

Updates an existing voucher within a loyalty program.

  • Path Parameters:

    • programId: UUID of the loyalty program
    • voucherId: UUID of the voucher
  • Request Body:

    • data: JSON object containing voucher data to be updated.
  • Returns:

    • Updated voucher details as a JSON object.
put/v2/loyalty/programs/{programId}/vouchers/{voucherId}

Path parameters

string required
OR
string required
Example:5eb7cf5a86d9755df3a6c593
string required
OR
string required
Example:5eb7cf5a86d9755df3a6c593

Headers

authorizationstring nullable

Request body

namestring required
descriptionstring nullable
startDatestring date-time nullable
endDatestring date-time nullable
type'welcome' | 'birthday' | 'other'
limitPerCustomerinteger nullable
availabilityCountinteger nullable
requireFieldsstring[] nullable
discountValuenumber nullable
discountCurrencystring nullable
discountType'fixed' | 'percent' | 'other'
categoriesstring nullable
productsstring nullable
priceRule'min' | 'max' | 'none'

Response

Successful Response

{"stackTrail":"paths:/v2/loyalty/programs/{programId}/vouchers/{voucherId}:put:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}