API - Planyo Web Services - modify_coupon

You are here: Planyo » Help » API » modify_coupon

modify_coupon

Description:

Makes modifications to an existing coupon. The parameters which you don't want to modify should not be passed.

Input:

coupon_id int required
Numeric ID of the coupon to be modified. You can get the coupon ID from the results of the list_coupons function.
resource_id string optional
The comma-separated resource IDs for which the coupon can be used. If passed as empty, the coupon will be used with all resources of the site.
amount int optional
The new amount of the coupon. Depending on the coupon type, this can be: prepaid amount, number of hours, number of entries or number of days.
language string optional
by specifying a 2-letter (ISO 639-1) language code (all capital letters e.g. EN, DE, FR, ES, IT) you can change the language of the text values returned
api_key string required
your API key - Click here to get your key. If your API key uses a hash key, you must also include the parameters hash_key and hash_timestamp.

Output:

warnings array
Warnings encountered during the update.

API playground:

Click here to test this function in the API playground.