API & Webhooks
Connect the Coupontools platform with your apps or web projects. The Coupontools REST API allows you to query meta-data about your account, campaigns, distribution, validations, and usage data.
-
Subaccount
- Retrieve a list of subaccounts
- Retrieve info of a subaccount
- Create a subaccount
- Update a subaccount
- Create password reset url for subaccount
- Single sign on for subaccounts
-
Campaign
- Retrieve a list of your campaigns
- Retrieve information from a campaign
- Retrieve all usage data from a campaign
- Retrieve all data from one coupon session
- Update data from a coupon session
- Update data from multiple coupon sessions
- Search coupon session
- Search coupon session from a campaign
- Send single push notification
- Send push notification to all
-
Loyalty Card
- Retrieve a list of your loyalty cards
- Retrieve a list of users from a loyalty card
- Update loyalty card user
- Send single push notification
- Send push notification to all
-
Directory
- Retrieve a list of your directories
- Retrieve information from a directory
- Retrieve all campaigns from a directory
- Retrieve registered users from a directory
- Update directory user payment status
- Retrieve a list of categories
- Retrieve a list of 3rd level categories
-
Single Use
- Create a single use access URL
- Create multiple single use access URLs
- Remove a single use access URL
Send a coupon by email
Send a coupon by email.You need to have an email marketing platform connected to be able to send out marketing emails. (Check out: integrations -> email marketing)
Base URL
POST: https://api4coupons.com/v3/send/email
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 | The unique ID from the campaign | Can be found in the list of all campaigns. |
Required
|
| 4 | Add the email address to this single use URL. |
Required
|
||
| 5 | subject | The subject from the email. |
Optional
|
|
| 6 | check_unique | Check if this e-mail address already got this coupon before sending. |
Optional
|
|
| 7 | firstname | Personalize email with a firstname. Please note that the email body text must contain [FIRSTNAME] |
Optional
|
|
| 8 | lastname | Personalize email with a lastname. Please note that the email body text must contain [LASTNAME] |
Optional
|
<?php $ch = curl_init(); $url = "https://api4coupons.com/v3/send/email"; $client_id = "XXX"; // Your API client ID (required) $client_secret = "YYY"; // Your API client secret (required) $data = [ 'campaign' => "cam_123456", 'email' => "john@doe.com" ]; 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); ?>
Example response
{
"status": {
"status": "OK"
},
"campaign": "cam_123456",
"subject": "Subject here",
"receiver": "info@receiver.com",
"single_use_code": "0ist0ywa4t9z7rj0g8mf7",
"single_use_url": "https://digicpn.com/p/abc123/0ist0ywa4t9z7rj0g8mf7",
"action": "email_sent"
}
Possible errors
- 104: No Email integration has been setup in your Coupontools account. Go to 'integrations' and 'Email marketing' to setup an Email provider.
- 200: Missing parameter: campaign
- 301: Invalid character in parameter: campaign.
- 305: Email address is not valid
- 502: Campaign ID not found.
- 604: Email not sent to 'foo@bar.baz'. Reason: foo