Directory
List directories
Retrieve a list of all directories.
GET https://api.coupontools.com/v4/directoryAuthentication:
API KeysExample
Response
Get directory
Retrieve directory information by ID.
GET https://api.coupontools.com/v4/directory/{id}Authentication:
API KeysExample
Response
Directory users
List users
Retrieve a list of all registered users for a directory.
GET https://api.coupontools.com/v4/directory/{id}/usersAuthentication:
API KeysExample
Response
Get user
Get a directory user by ID.
GET https://api.coupontools.com/v4/directory/{id}/users/{userId}Authentication:
API KeysExample
Response
Create user
Create a directory user.
POST https://api.coupontools.com/v4/directory/{id}/usersAuthentication:
API KeysParameters
| Parameter | Input | ||
|---|---|---|---|
| Email address | Required | ||
| password | Password | If not defined, we'll generate a random password | Optional |
| first_name | First name | Optional | |
| last_name | Last name | Optional | |
| phone | Phone | Optional | |
| birth_date | Birth date | YYYY-MM-DD | Optional |
| address | Address | Optional | |
| zip | Zip | Optional | |
| city | City | Optional | |
| custom_1 | Custom 1 | Optional | |
| custom_2 | Custom 2 | Optional | |
| custom_3 | Custom 3 | Optional |
Example
Response
Update user
Update a directory user. Currently only supports block.
POST https://api.coupontools.com/v4/directory/{id}/users/{userId}Authentication:
API KeysParameters
| Parameter | Input | ||
|---|---|---|---|
| block | true/false | (un)block users to (dis)allow access to directory | Optional |
Example
Response
Create single sign-on
Creates a single-use single sign-on token. When passing the token in the url, the browser will automatically sign in as the requested user. The token will only be valid once.
POST https://api.coupontools.com/v4/directory/{id}/users/{userId}/ssoAuthentication:
API KeysExample
Response
Distribution
Send directory by email
Distribute your directory through email. Sending emails requires a positive email balance/credit (check out: integrations -> email marketing).
POST https://api.coupontools.com/v4/directory/{id}/send/emailAuthentication:
API KeysParameters
| Parameter | Input | ||
|---|---|---|---|
| receiver | Email address of receiver | Required | |
| sender | Email address of sender | By default we'll use noreply@yourwhitelabeldomain.com | Optional |
| type | text or html | text: Plain text body html: HTML body (automatically parsed before sending) | Optional |
| subject | Subject of email | Optional | |
| body | Body of email | Set 'type' parameter to 'html' to pass HTML body. Body is automatically parsed before sending. | Optional |
| button_text | Text on button | By default button_text is set to 'View deals' | Optional |
Example
Response
Send directory by text message
You need to have an SMS marketing platform connected to be able to send out SMS messages (check out: integrations -> SMS marketing).
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 leading 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
POST https://api.coupontools.com/v4/directory/{id}/send/smsAuthentication:
API KeysParameters
| Parameter | Input | ||
|---|---|---|---|
| receiver | Phone number of receiver | International E.164 notation | Required |
| body | Body of SMS | The directory URL will be added to the back of the message | Optional |