[R] Update a coupon

put

https://sandbox.xola.com/api/coupons/{id}

Updates the specified coupon.

To perform this action, you must be the account owner, or must be delegated with ROLE_MARKETER, or ROLE_SELLER_ADMIN.

Note: This feature utilizes the triggers and rewards syntax.

Path Params

string

required

ID of the coupon.

Body Params

string

required

The ID of the coupon to modify

seller

object

required

name

string

Name of the coupon campaign.

algorithm

string

required

Algorithm used to calculate the discount. Possible values are percent, absolute.

amount

float

required

Amount of the discount.

codes

array of strings

required

List of unique codes that may be used to redeem this coupon.

codes*

experiences

object

required

An ExperienceList object detailing whether the coupon applies to all experiences in the seller account, or just a specific subset

purchaseAmount

float

Amount paid by the customer for this coupon. This may be lower than the amount in case of promotional campaigns.

paymentMethod

string

Reported payment method when this voucher is used. Applicable and required for voucher types.

limit

int32

Limits the number of times the coupon can be used.

bookBySchedule

array of objects

Restriction which ensures that this coupon is only redeemable within the specified schedules.

bookBySchedule

arrivalSchedule

array of objects

Restriction which ensures that this coupon can only be used for orders whose arrival is within the specified schedules.

arrivalSchedule