Message service
List groups
Retrieve a list of all SMS groups.
POST
https://api.coupontools.com/v3/smstool/grouplist
Authentication:
API KeysExample
Loading...
Response
Loading...
Possible errors
103: Your account is not connected with the Coupontools SMS services
List contacts
Retrieve a list of all contacts from an SMS group.
POST
https://api.coupontools.com/v3/smstool/userlist
Authentication:
API KeysParameters
Parameter | Input | ||
---|---|---|---|
smsgroup | SMS group ID (gro_XXXXXX) | Can be found in the 'List groups' API response | Required |
Example
Loading...
Response
Loading...
Possible errors
103: Your account is not connected with the Coupontools SMS services
200: Missing parameter: smsgroup
301: Invalid character in parameter: smsgroup
514: Group ID not found
Create group
Create an SMS group.
POST
https://api.coupontools.com/v3/smstool/addgroup
Authentication:
API KeysParameters
Parameter | Input | ||
---|---|---|---|
group_name | Name of the group | Required |
Example
Loading...
Response
Loading...
Possible errors
103: Your account is not connected with the Coupontools SMS services
Add contact
Add a contact to an SMS group.
POST
https://api.coupontools.com/v3/smstool/addcontact
Authentication:
API KeysParameters
Parameter | Input | ||
---|---|---|---|
smsgroup | SMS group ID (gro_XXXXXX) | Can be found in the 'List groups' API response | Required |
phone | Valid phone number | International E.164 notation | Required |
first_name | Contact first name | Optional | |
last_name | Contact last name | Optional | |
customfield1 - customfield7 | Add data to custom field 1 through 7 | Optional |
Example
Loading...
Response
Loading...
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
Email service
List groups
Retrieve a list of all email groups.
POST
https://api.coupontools.com/v3/emailtool/grouplist
Authentication:
API KeysExample
Loading...
Response
Loading...
Possible errors
103: Your account is not connected with the Coupontools Email services
List contacts
Retrieve a list of all contacts from an email group.
POST
https://api.coupontools.com/v3/emailtool/userlist
Authentication:
API KeysParameters
Parameter | Input | ||
---|---|---|---|
emailgroup | Email group ID (gro_XXXXXX) | Can be found in the 'List groups' API response | Required |
Example
Loading...
Response
Loading...
Possible errors
103: Your account is not connected with the Coupontools Email services
200: Missing parameter: emailgroup
301: Invalid character in parameter: emailgroup
514: Group ID not found
Create group
Create an email group.
POST
https://api.coupontools.com/v3/emailtool/addgroup
Authentication:
API KeysParameters
Parameter | Input | ||
---|---|---|---|
group_name | Name of the group | Required |
Example
Loading...
Response
Loading...
Possible errors
103: Your account is not connected with the Coupontools Email services
Add contact
Add a contact to an email group.
POST
https://api.coupontools.com/v3/emailtool/addcontact
Authentication:
API KeysParameters
Parameter | Input | ||
---|---|---|---|
emailgroup | Email group ID (gro_XXXXXX) | Can be found in the 'List groups' API response | Required |
Valid email address | Required | ||
first_name | Contact first name | Optional | |
last_name | Contact last name | Optional | |
custom1 - custom10 | Add data to custom field 1 through 10 | Optional |
Example
Loading...
Response
Loading...
Possible errors
103: Your account is not connected with the Coupontools Email services
200: Missing parameter: email
200: Missing parameter: emailgroup
301: Invalid character in parameter: emailgroup
303: incorrect format in birthday field, must be yyyy-mm-dd
514: Group ID not found
Webhooks
Click here for more information
about webhooks.
Example webhooks for coupon, coupon edit, subaccount and, landing page.
Coupon
Loading...
Coupon edit
Loading...
Subaccount
Loading...
Loyalty page
Loading...
Landing page
Loading...
Directory page
Loading...
Verification
Get important information about a webhook which can be used as verification.
POST
https://api.coupontools.com/v4/webhook/verification
Authentication:
API KeysParameters
Parameter | Input | ||
---|---|---|---|
webhook | Webhook id (evt_XXXXXXXXXXXXXXXXXXXX) | Can be found in the "id" property of a webhook payload | Required |
Example
Loading...
Response
Loading...
Possible errors
200: Missing parameter: webhook
509: Webhook not found