API Reference

Update Coupon

put
https://api.vcita.biz/v2/coupons/

Overview

Updates an existing coupon. Available for Staff tokens.

Validation Rules

The same validation rules as coupon creation apply. Additionally:

  • You cannot change the code to a code that is already in use by another active coupon.
  • You cannot change the name to a name that is already in use by another active coupon.
Path Params
string
required

The unique identifier of the coupon to update.

Body Params
string

The display name of the coupon (e.g., "Summer Sale"). Must be unique among active coupons.

string
enum

The type of discount. Possible values: fixed (a fixed monetary amount off) or percent (a percentage off).

Allowed:
string

The coupon code that clients enter to redeem the discount. Must be 5-15 characters, alphanumeric and underscores only.

number

The discount value. For percent type, this is the percentage (e.g., 50 means 50% off). For fixed type, this is the monetary amount in the business currency.

date-time

The date and time when the coupon becomes active, in ISO 8601 format.

date-time

The date and time when the coupon expires, in ISO 8601 format. Must be later than starts_at.

integer

The maximum total number of times this coupon can be redeemed. Set to null for unlimited.

integer

The maximum number of times a single client can redeem this coupon. Set to null for unlimited.

valid_services
array of strings

An array of service UIDs this coupon is valid for. Set to null for all services.

valid_services
valid_staff
array of strings

An array of staff UIDs whose services this coupon is valid for. Set to null for all staff.

valid_staff
Responses

Updated 2 months ago

Language
Credentials
Bearer
JWT
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 2 months ago