The Phone Number/Email Lists API allows you to manage opt-out list by providing documentation for adding or deleting contacts through the API.
To view the API documentation for each list, go to the List Management > Phone Number/Email Opt-out Lists section.
Click the “API Doc” button in the “Actions” column. The system will show the API documentation for the respective Phone Number/Email Opt-out List.
The document contains the following information:
To download the documentation in PDF format, click the “Get as PDF” button.
To switch between Phone Number Lists and Email Lists, click the “Phone Number Lists” or “Email Lists” button in the upper left corner.
General info
The General info block allows you to view a short guide on where to find the API Key to add or delete contacts from the Phone Number/Email Opt-out Lists through the API.
Adding contacts to Mailing List's
The Adding contacts to Mailing List's section contains all the information on how to add contacts to the Phone Number/Email Opt-out Lists through the API.
The Introduce block allows you to view the link to which a POST request should be made to add a Phone Number or Email to the list.
To add a Phone Number, append "/phones-add" to the end of the link.
To add an Email, append "/emails-add" to the end of the link.
The Request Fields block allows you to view the Phone Number or Email Lists API specifications.
The information is separated into the following columns:
- Field Name: The name of the field.
- Required (YES/NO): Displays if the field is required.
- Description: The description of the information in the field.
- Example: The data examples.
- Format: Displays the data format that should be used in the field.
3. Sample PHP Code
The Sample PHP Code block allows you to view examples of requests.
4. Response Samples
The Response Samples block contains the templates of responses for a successful contact addition or an error.
The information is separated into four blocks:
- Success Add: Example of a response when a phone number or email is successfully added to the list.
- API Key Error: Example of a response when the List API Key is invalid.
- HTTP Method Error: Example of a response when the HTTP method is not allowed.
- Missing Required Param Error: Example of a response when a required parameter was not entered.
Removing contacts from Mailing List's
The Removing contacts from Mailing List's section contains all the information on how to remove contacts from the Phone Number/Email Opt-out Lists through the API.
The Removing contacts from Mailing List's section is divided into the same four blocks as the Adding contacts to Mailing List's section, with the difference in the POST URL string being "/phones-delete" and "/emails-delete".
In the Response Samples block, instead of Success Add, there is a Success Remove block demonstrating the response example for successfully removing a contact from the Phone Number/Email Opt-out Lists.
