View Coupon Details

Coupon details involves coupon code, recipient details, coupon campaign name, sent date, expiry date and the current status of the coupon. Using this API, you can view the coupon details.

Request Type:

POST

Scope required

ZohoCampaigns.campaign.READ

Other alternative scopes

ZohoCampaigns.campaign.ALL (CREATE + UPDATE + DELETE + READ)

Header:

Authorization: Zoho-oauthtoken <access_token>

Request URL

https://campaigns.zoho.com/api/v1.1/coupon/coupondetails

API Limit

Duration: 10 mins
Number of calls: 100
Lock Period: 30 mins

You can send 100 API calls per 10 minutes. If you hit this limit, you can't use this API for the next 30 minutes due to security reasons, but you can still use other APIs if their lock period hasn’t been reached.

List of Parameters: -- Version 1.1

Parameter	Data Type	Description
type	String	XML (or) JSON
couponCode*	String	Get it from recent coupon campaign.

* - Mandatory Parameters

Sample XML Request

Copiedhttps://campaigns.zoho.com/api/v1.1/coupon/coupondetails?type=xml&couponCode=[Couponcode]

Sample Response

Copied<response uri="/api/v1.1/coupon/coupondetails" version="1.1">
	<code>200</code>
	<message>Success</message>
	<CouponDetails>
		<couponid>42660000000513041</couponid>
		<coupon>TESTTSIGiCvV</coupon>
		<couponprefix>TESTTSI</couponprefix>
		<recipient>patriciab@zylker.com</recipient>
		<campaignname>Coupon campaign Api Use</campaignname>
		<senton>07/30/2014 10:40 AM IST </senton>
		<expireon>08/28/2014 10:00 PM IST </expireon>
		<status>Active</status>
		<usedon>0</usedon>
	</CouponDetails>
</response>

Sample JSON Request

Copiedhttps://campaigns.zoho.com/api/coupon/coupondetails?type=xml&version=1&couponCode=[Couponcode]

Sample Response

Copied{
"response":{
"message":"Success",
"code":"200",
"CouponDetails":{
"usedon":"0",
"campaignname":"Coupon campaign Api Use",
"status":"Active",
"expireon":"08/28/2014 10:00 PM IST",
"senton":"07/30/2014 10:40 AM IST",
"couponprefix":"TESTTSI",
"coupon":"TESTTSIGiCvV",
"couponid":"42660000000513041",
"recipient":"patriciab@zylker.com"
},
"uri":"/api/v1.1/coupon/coupondetails",
"version":"1.1"
}
}