Welcome to Version 3.2 of the API.
The reference pages include information that will help you use a method, including the method structure, parameter definitions, and sample code. Before using this guide, you should have a good understanding of Web Services, and you should be familiar with the user interface.
If you are not a developer, we strongly suggest that you do not attempt to use the API code; you may accidentally delete or modify system data or otherwise interfere with your system's ability to operate.
Help is available in a variety of formats that you can access from the user interface. Click the Help link in your account to access the Help Centre where you can ask a question directly to the Support team. Free Live Training Sessions are available should you wish to gain a better understanding on how the user interface works prior to implementing the API.
- Getting Started
- Common Use Cases
- Basic Structure of the API
- Optimising API Performance
- Using Search Methods
API Method Reference Index
- Account Methods
- Autoresponder Methods
- Contact Methods
- File Methods
- Folder Methods
- List and Field Methods
- Message and Batch Methods
- Webhook Methods
Glossary, Error Codes, and Reserved Words
Guide to Styles Used in This Documentation
|System Object||first letter upper-case||Folder|
|Method, Field, Code||typewriter font||
|Field value, parameter value||italics||campaign|
When any of the items above are displayed in a code example, they are shown in in the same typewriter font as the rest of the code in the example.