Coupontools Logo

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.

Create a subaccount

Create a new subaccount
Base URL
POST: https://api4coupons.com/v3/subaccount/create
Parameters
# Parameter Input Description
1 client_id API client ID
Required
Can be found in your API documentation
2 client_secret API client secret
Required
Can be found in your API documentation
3 username New subaccount username
Required
No spaces or special characters.
4 password New subaccount password
Required
5 expiry_date Account expiry date
Required
Date format: YYYY-MM-DD
6 available_campaigns Amount of available campaigns
Optional
Default=0. Numeric only.
7access_dashboardtrue or false
Optional
Default true
8access_directorytrue or false
Optional
Default false
9access_validation_widgettrue or false
Optional
Default false
10access_settingstrue or false
Optional
Default false
11access_validation_apptrue or false
Optional
Default false
12access_supporttrue or false
Optional
Default false
13access_contactpagetrue or false
Optional
Default true
14access_statstrue or false
Optional
Default true
15access_stats_exporttrue or false
Optional
Default true
16email_reporttrue or false
Optional
Default false
17show_amount_campaignstrue or false
Optional
Default true
18access_addcampaigntrue or false
Optional
Default true
19access_updatecampaigntrue or false
Optional
Default true
20access_removecampaigntrue or false
Optional
Default true
21access_loyaltycardstrue or false
Optional
Default false
22access_addloyaltytrue or false
Optional
Default false
23access_updateloyaltytrue or false
Optional
Default false
24access_removeloyaltytrue or false
Optional
Default false
25enable_webhookstrue or false
Optional
Default false
26enable_review_managertrue or false
Optional
Default false
27first_nameFirst name
Optional
28last_nameLast name
Optional
29company_nameCompany name
Optional
30webhook_endpointWebhook endpoint
Optional
31currencyCurrency
Optional
32languageLanguage
Optional
33shown_templatesall, own or system
Optional
Set which templates are shown to this subaccount
34buildertypetext_only, lite or advanced
Optional
35webhook_typeall, sociallogin, claim or validation
Optional
36integrationsnone, all, whitelabel or specified
Optional
Example success response
{
	"status": {
		"status": "OK"
	},

	"subaccount": {
		"ID": "sub_123456",
		"status": "created",
		"api_key": "3824662711434985877623512188917",
		"api_secret": "Q1OusZaDrtynnrdZugCwVAdNanbzps"
	}
}
Example error response
{
	"status": {
		"status": "failed",
		errors": {
			"error_message": "HTTP/1.0 422 Unprocessable entity.",
			"error_message_description": [
				"Username already exists."
			],
			"error_code": [
				304
			]
	}
}
Possible errors
  • 200: Missing parameter: username
  • 200: Missing parameter: password
  • 200: Missing parameter: expiry_date
  • 300: Invalid character in parameter: username
  • 301: Invalid character in parameter: available_campaigns. Only numeric values allowed.
  • 303: Invalid format in parameter: expiry_date. Required format: YYYY-MM-DD
  • 304: Username already exists.

Register now for a 7-days free trial account

Start using Coupontools today!

Great you're here! Cookies? Read our Privacy Policy. I accept
x