Product Vouchers

Update a product voucher. Roles: admin.

Changed on
put/api/product-vouchers/{productVoucherId}

Request

  • Base URL
    https://api.mobilecoach.org (the document declares no server; this is the origin it was published from)
  • URL
    https://api.mobilecoach.org/api/product-vouchers/{productVoucherId}
  • Auth
    AuthToken (a scheme the document does not define)

Path parameters

productVoucherIdinteger required

Query parameters

localestring

Request body

productIdinteger required
codestring required
descriptionstring
discountAmountinteger
discountPercentinteger
maxRedemptionsinteger
autoAppliedboolean required
groupIdinteger
groupRoleIdinteger
startDateTimestring date-time
endDateTimestring date-time

Response

OK

successboolean
errorstring

Changes

  • 6e5d224eed9bRevision changes
    • warning

      added the new AGE enum value to the /// response property for the response status

    • warning

      added the new GREATER_THAN_OR_EQUALS enum value to the /// response property for the response status

    • warning

      added the new LESS_THAN_OR_EQUALS enum value to the /// response property for the response status

  • 887e7398ca4aRevision changes
    • info

      added the optional property /// to the response with the status