Directory
List directories
Retrieve a list of all directories.
POST https://api.coupontools.com/v3/directory/listAuthentication:
API KeysExample
Response
Get directory
Retrieve directory information by ID.
POST https://api.coupontools.com/v3/directory/infoAuthentication:
API KeysParameters
Can be found in the list of all directories
Example
Response
Possible errors
Directory users
List users
Retrieve a list of all registered users for a directory. The API response returns the registrations in a reverse-chronologically ordered array limited to max. 100 registrations. Use the "page" parameter in order to retrieve "older" registrations.
POST https://api.coupontools.com/v3/directoryusers/listAuthentication:
API KeysParameters
Can be found in the list of all directories
Page is limited to 100 registrations
Example
Response
Possible errors
Distribution
Send directory by email
You need to have an email marketing platform connected to be able to send out marketing emails (check out: integrations -> email marketing).
POST https://api.coupontools.com/v3/send/emailAuthentication:
API KeysParameters
Can be found in the list of all directories
Recipient of the directory email
Subject of email
Example
Response
Possible errors
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/v3/send/smsAuthentication:
API KeysParameters
Can be found in the list of all directories
Phone number receiving directory. International E.164 notation
SMS body text. The directory URL will be added to each message