Retrieve a campaign - API's & Webhooks Coupontools

Retrieve information from a campaign

Returns information of one specific campaign.

Base URL

POST: https://api4coupons.com/v3/coupon/info

Parameters

#	Parameter	Input	Description
1	client_id	API client ID	Can be found in your API documentation	Required
2	client_secret	API client secret	Can be found in your API documentation	Required
3	campaign	ID from the campaign	Can be found in the list of all campaigns. Example: cam_12345	Required
4	show_usage_stats	true or false	Defaults to false, will add the total numer of custom validation codes en number of claimed custom codes	Optional

<?php
	$ch = curl_init();
	$url = "https://api4coupons.com/v3/coupon/info";
	$client_id = "XXX"; // Your API client ID (required)
	$client_secret = "YYY"; // Your API client secret (required)
	$data = [
		'campaign' => "cam_123456"
	];
	curl_setopt($ch, CURLOPT_URL, "$url");
	curl_setopt($ch, CURLOPT_POST, true);
	curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
	curl_setopt($ch, CURLOPT_VERBOSE, true);
	curl_setopt($ch, CURLOPT_HTTPHEADER, [
		"X-Client-Id: $client_id",
		"X-Client-Secret: $client_secret",
		"Content-Type: application/json",
	]);
	curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode($data));
	$response = curl_exec($ch);
?>

const https = require("https");
const client_id = "XXX"; // Your API client ID (required)
const client_secret = "YYY"; // Your API client secret (required)
const data = JSON.stringify({
	campaign: "cam_123456"
});
const options = {
    hostname: "api4coupons.com",
    port: 443,
    path: "/v3/coupon/info",
    method: "POST",
    headers: {
        "X-Client-Id": client_id,
        "X-Client-Secret": client_secret,
		"Content-Type": "application/json",
		"Content-Length": data.length,
    },
};
const req = https.request(options, (res) => {
    console.log(`statusCode: ${res.statusCode}`);
    res.on("data", (d) => {
        process.stdout.write(d);
    });
});
req.write(data);
req.end();

require "uri"
require "net/http"

url = URI("https://api4coupons.com/v3/coupon/info")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Client-Id"] = "XXX" // Your API client ID (required)
request["X-Client-Secret"] = "YYY" // Your API client secret (required)
request["Content-Type"] = "application/json"
form_data = [
	['campaign', "cam_123456"]
]
request.set_form form_data, 'multipart/form-data'
response = https.request(request)
puts response.read_body

import requests
url = "https://api4coupons.com/v3/coupon/info"
payload={
	'campaign': 'cam_123456'
}
files=[]
headers = {
	'X-Client-Id': 'XXX', #Your API client ID (required)
	'X-Client-Secret': 'YYY', #Your API client secret (required)
	'Content-Type': 'application/json'
}
response = requests.request(
	"POST",
	url,
	headers=headers,
	data=payload,
	files=files
)
print(response.text)

var url = "https://api4coupons.com/v3/coupon/info";
var client = new RestClient(url);
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("X-Client-Id", "XXX"); // Your API client ID (required)
request.AddHeader("X-Client-Secret", "YYY"); // Your API client secret (required)
request.AddHeader("Content-Type", "application/json");
request.AlwaysMultipartFormData = true;
request.AddParameter("campaign", "cam_123456");
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Example response

				{
					"status": {
						"status": "OK"
					},
					"coupon_info": {
						"ID": "cam_123456",
						"code": "abc123",
						"url": "https://digicpn.com/p/abc123",
						"status": "example",
						"subaccount": "",
						"name": "[NO NAME]",
						"title": "10% OFF",
						"subtitle": "On all pizzas",
						"description": "",
						"expirydate": "2018-08-12 11:19:00",
						"timezone": "UTC",
						"terms": "",
						"terms_short": "Example coupon;",
						"poweredby": "Your Company",
						"poweredbylink": "http://www.yourwebsite.com",
						"coupon_tags": "",
						"coupon_category": "1",
						"coupon_category_name": "",
						"logo_url": "https://hosting4images.com/upload/logo/302_logo_170518101046.jpg",
						"banner1": "https://www.hosting4images.com/preview/image.jpg",
						"banner2": "https://www.hosting4images.com/preview/image.jpg",
						"banner3": "https://www.hosting4images.com/preview/image.jpg",
						"banner4": "https://www.hosting4images.com/preview/image.jpg",
						"banner5": "https://www.hosting4images.com/preview/image.jpg",
						"coupon_image": "https://hosting4images.com/upload/customimage/image.jpg",
						"locations": [
							{
								"ID": "loc_12345",
								"company_name": "location",
								"company_email": "info@location.com",
								"company_phone": "",
								"company_password": "123456789",
								"company_street": "",
								"company_zip": "",
								"company_city": "",
								"company_state": "",
								"company_country": "",
								"company_lat": "0.000000",
								"company_long": "0.000000",
								"company_hours": ""
							}
						],
						"amount": 20, (only calculated when show_usage_stats is true)
						"amount_claimed": 5, (only calculated when show_usage_stats is true)
						"amount_validated": 4, (only calculated when show_usage_stats is true)
						(following three are only shown when the campaign is configured to generate codes)
						"code_prefix": "ab_3_",
						"code_length": "20",
						"code_type": "numeric"
					}
				}

Possible errors

200: Missing parameter: campaign
301: Invalid character in parameter: campaign.
502: Campaign ID not found.

API & Webhooks

API

Guides

Account

Subaccount

Campaign

Loyalty Card

Directory

Single Use

Coupontools SMS services

Coupontools Email services

Retrieve information from a campaign

Base URL

Parameters

Example response

Possible errors

Register now for a 7-days trial account

Products

By Business Type

By Need

By Industry

By Marketing Approach

API & Webhooks

API

Guides

Account

Subaccount

Campaign

Loyalty Card

Directory

Single Use

Coupontools SMS services

Coupontools Email services

Retrieve information from a campaign

Base URL

Parameters

Example response

Possible errors

Register now for a 7-days trial account