Account
Create single sign on
Generates a single sign on token for an account.
POST
https://api.coupontools.com/v3/account/sso
Authentication:
API KeysExample
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 KeysParameters
Parameter | Input | ||
---|---|---|---|
teammate | Teammate ID | Numeric only | Required |
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 KeysExample
Loading...
Response
Loading...
Get subaccount
Retrieve subaccount information by ID.
POST
https://api.coupontools.com/v4/subaccount
Authentication:
API KeysParameters
Parameter | Input | ||
---|---|---|---|
subaccount | Subaccount ID (sub_XXXXXX) | Can be found in the list of your subaccounts | Required |
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 KeysParameters
Parameter | Input | ||
---|---|---|---|
Email address | Required | ||
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 | First name | Optional | |
last_name | Last name | Optional | |
country | Country code | Alpha-2 country code (f.e. US, FR, MX, ...) | Optional |
company_name | Company name | Optional | |
expiry_date | Account expiry date | Date format: YYYY-MM-DD | Optional |
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 KeysParameters
Parameter | Input | ||
---|---|---|---|
subaccount | Subaccount ID (sub_XXXXXX) | Can be found in the list of your subaccounts | Required |
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 KeysParameters
Parameter | Input | ||
---|---|---|---|
subaccount | Subaccount ID (sub_XXXXXX) | Can be found in the list of your subaccounts | Required |
Example
Loading...
Response
Loading...
Possible errors
200: Missing parameter: subaccount
510: Subaccount ID not correct