Account

Create single sign on

Generates a single sign on token for an account.

POST https://api.coupontools.com/v3/account/sso

Authentication:

API Keys

Example

Loading...

Response

Loading...

Teammate

Create single sign on

Generates a single sign on token for a teammate.

POST https://api.coupontools.com/v3/teammate/sso

Authentication:

API Keys

Parameters

Required teammate Teammate ID
Numeric only

Example

Loading...

Response

Loading...

Possible errors

200: Missing parameter: campaign
200: Missing parameter: teammate
301: Invalid character in parameter: campaign
301: Invalid character in parameter: teammate
502: Campaign ID not found
503: Teammate ID not found

Subaccount

List subaccounts

Retrieve a list of all subaccounts.

POST https://api.coupontools.com/v4/subaccount/list

Authentication:

API Keys

Example

Loading...

Response

Loading...

Get subaccount

Retrieve subaccount information by ID.

POST https://api.coupontools.com/v4/subaccount

Authentication:

API Keys

Parameters

Required subaccount Subaccount ID (sub_XXXXXX)
Can be found in the list of your subaccounts

Example

Loading...

Response

Loading...

Create subaccount

Create a subaccount. Set subaccount permissions by passing the package ID in the payload.

POST https://api.coupontools.com/v4/subaccount/create

Authentication:

API Keys

Parameters

Required email Email address
 
Optional password Password
If not provided, subaccount will get password configuration email
Optional package Package ID (pac_XXX)
Can be found on the package page in your dashboard
Optional status trial | customer
Define the status of the subaccount
Optional first_name String
 
Optional last_name String
 
Optional country String
Alpha-2 country code (f.e. US, FR, MX, ...)
Optional company_name String
 
Optional expiry_date Date (format: yyyy-MM-dd)
 

Example

Loading...

Response

Loading...

Possible errors

200: Missing parameter: email
303: Invalid format in parameter: expiry_date. Required format: yyyy-MM-dd
304: Email already exists
305: Email address is not valid

Create password reset URL

Create password reset URL for subaccount.

POST https://api.coupontools.com/v3/subaccount/reset/url

Authentication:

API Keys

Parameters

Required subaccount Subaccount ID (sub_XXXXXX)
Can be found in the list of your subaccounts

Example

Loading...

Response

Loading...

Possible errors

200: Missing parameter: subaccount
510: Subaccount ID not found

Create single sign on

Generates a single sign on token for a subaccount.

POST https://api.coupontools.com/v3/subaccount/sso

Authentication:

API Keys

Parameters

Required subaccount Subaccount ID (sub_XXXXXX)
Can be found in the list of your subaccounts

Example

Loading...

Response

Loading...

Possible errors

200: Missing parameter: subaccount
510: Subaccount ID not correct