Users can change the status of a coupon code using an API auth token.

Request URL

XML/ JSON

https://campaigns.zoho.com/api/coupon/changestatus

Request Type:  Get/ Post

Parameters:

Parameter

Data Type

Description

authtoken*
scope*

String
String

API Authentication Token
CampaignsAPI

version

String

This will fetch responses based on the current API version.

type

String

XML (or) JSON

couponCode*

String

Get it from recent coupon campaign.

* - Mandatory Parameters

Sample Request:

XML/ JSON

  • https://campaigns.zoho.com/api/coupon/changestatus?authtoken=[API Authentication Token]&scope=CampaignsAPI&type=xml&version=1&couponCode=[CouponCode]&changeStatus=used

Sample Response:

Our API response will let you know of the following be it in the XML or JSON format.

XML Format:

<response uri="/api/coupon/changestatus" version="1">
<code>200</code>
<message>Coupon status changed to 'Used'</message>
</response>

JSON format:

{
"response":{
"message":"Coupon status changed to 'Used'",
"code":"200",
"uri":"/api/coupon/changestatus",
"version":"1"
}
}