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
Add a SMS subscriber to a group
Add a new subscriber to an existing SMS group.E.164 phone number format:
First of all, in the international E.164 notation a leading '0' is removed.
The UK mobile phone number '07911 123456' in international format is '+44 7911 123456', so without the first zero.
Secondly in the E.164 notation all spaces, dashes ['-'] and parentheses [ '(' and ')'] are removed, besides the leading '+' all characters should be numeric.
Example: +447911123456
Base URL
POST: https://api4coupons.com/v3/smstool/addcontact
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 | smsgroup | ID of the SMS group | Can be found in the SMS Group list API endpoint. |
Required
|
| 4 | phone | A valid mobile phone number | In E.164 format |
Required
|
| 5 | first_name | The subscribers first name |
Optional
|
|
| 6 | last_name | The subscribers last name |
Optional
|
|
| 7 | customfield1 - customfield7 | User defined fields |
Optional
|
<?php $ch = curl_init(); $url = "https://api4coupons.com/v3/smstool/addcontact"; $client_id = "XXX"; // Your API client ID (required) $client_secret = "YYY"; // Your API client secret (required) $data = [ 'smsgroup' => "gro_12345", 'phone' => "+123456789" ]; 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"
},
"group_id": "gro_123456",
"phone": "1234566778899",
"first_name": "Bill",
"last_name": "Jackson",
"result": "saved_succesfully",
"contact_id": "con_12345678"
}
Example error response
{
"status": {
"status": "OK"
},
"group_id": "gro_123456",
"phone": "1234566778899",
"first_name": "Bill",
"last_name": "Jackson",
"result": "already_found"
}
Possible errors
- 103: Your account is not connected with the Coupontools SMS services
- 200: Missing parameter: phone.
- 200: Missing parameter: smsgroup
- 301: Invalid character in parameter: smsgroup.
- 303: incorrect format in birthday field, must be yyyy-mm-dd
- 514: Group ID not found in your account!