MailClickConvert API Developer Documentation

We offer a RESTFUL API. Each API key can be generated from the API tab in the software. Multiple keys can be created and define what API's each key has access to.

Full List of API's

Webhook Documentation and Information

Basic API Handling

API calls can be made either via post or get unless indicated otherwise for the api.

Each API call requires at least the following parameters passed:

						apikey - The API key found under the Get API Key in the API section
						area - The part of the system that is being called examples include email, home, clients
						action - The API call itself is passed in the action
					

Example API call: https://api.mailclickconvert.com/api.php?apikey=YOURAPIKEYHERE&area=home&action=getusers

							<response>
							<user>
							<id>1337</id>
							<firstname>John></firstname>
							<lastname>Doe</lastname>
							<username>username</username>
							<email>test@test.com</email>
							<lastlogin>October 17, 2025, 03:15:17 pm</lastlogin>
							<primaryuser>No</primaryuser>
							</user>
							</response>
						

For API calls that have paging support for their return example the following parameters are available:

						start - Starting position in the query
						limit - Max number of records that can be returned. Max value is 1000
					

Example Paging API call: https://api.mailclickconvert.com/api.php?apikey=YOURAPIKEYHERE&area=email&action=getmessages&start=0&limit=5

The api will return a result. And also in ever page call return an element called <records> which contains the total records.

						<response>
						<records>2</records>
						<message>
						<id>45911</id>
						<title>Message 1</title>
						<datecreated>August 11, 2025, 09:18:08 pm</datecreated>
						<numberoftimesused>0</numberoftimesused>
						<datelastused>Never</datelastused>
						<locked>0</locked>
						</message>
						

						<message>
						<id>45910</id>
						<title>Message 2</title>
						<datecreated>August 11, 2025, 09:17:39 pm</datecreated>
						<numberoftimesused>2</numberoftimesused>
						<datelastused>October 11, 2020, 11:42:04 pm</datelastused>
						<locked>0</locked>
						</message>
						</response>
					

Error Handling

In the event of an error. The API will return the error message in the following format:

						<response>
						<error>Error Message Appears Here</error>
						</response>
					

API output methods

By default, the api will xml as the result of an api call. We also support JSON,csv for an output mode as well. To change the output mode for the api result add the following to your request. output=json output=csv Or output=xml

Some API Calls such as "verifysingleemail" are rated limited to 1 API Call per second. Otherwise the default limit is 10 calls per second

And will return the following error if you exceed it:

						<response>
						<error>Rated Limited 1 API Query a Second</error>						
						</response>
					

To avoid rate limiting do a sleep call or similar function and have it delay execution for 1 to 2 seconds for each call.