Sign in
Promocode Endpoints

Create a promocode

Create a promocode for a coupon

You can provide the API with a code, but if you don't we'll generate one for you.

You can just POST an empty body to create a promocode for a coupon with a generated code.

With promocodes you can specify minimum booking values, redemptions limits, limit only to one customer, and limit one use per customer.

Once created, a Promocode can be used to apply the Coupon to a booking via the customer booking form

post/coupons/{coupon_id}/promocodes.json

Path parameters

coupon_idinteger required

Coupon ID to create promocode for

Headers

Authorizationstring required

Response

Promocode created

idinteger
codestring

The code the customer can use to redeem the promocode, they enter this code when booking.

The code is case-insensitive and must be unique

minimum_booking_valueinteger

The minimum booking value the Promocode can be used for.

If attempted for a booking below this value, the Coupon will not be applied

first_time_use_onlyboolean

If set to true, the Promocode will only be usable once per customer - applies to logged in customers only

Changes

Changed in 3 of the 32 revisions of this API.22