Welcome To The API User Guide

The Total Send API makes integration of Total Send with third party applications and websites possible. With the help of Total Send API, you can get your data from Total Send without visiting the Total Send user interface.

You can gather your data from Total Send API, populate and use it in your own systems. There are endless possibilities about things you can do with the Total Send API. You can develop a desktop application, mobile application, websites, etc.

In this article, we will show you how to use the Total Send API and the API function reference. If you have any questions, do not hesitate to contact us anytime.

Getting Started

To use the Total Send API, you will need your API username and password. With your API credentials, you will be able to open an API session and then access to protected API commands such as getting the list of your subscriber lists.

Your API credentials are different to your normal account login credentials. Please contact support to receive your API credentials.

In addition to your API credentials, you may need to set some more parameters during the API connection. These parameters may vary for each API command you are using. In the following sections, we will explain each available Total Send API command to you.

How To Start?

Most Total Send API commands require user authentication. This is clearly marked in API command reference pages. To begin, get a session ID by executing "User.Login" API call.

Use the created session ID with your API credentials for connecting to other Total Send API commands.

The API URL Pattern

The Total Send API URL allows you to connect and get a response from Total Send.


Example API Connection

In this example, we will connect to Total Send API and authenticate to get the session ID. The session ID will be required for executing any other API commands such as getting the list of subscribers.

Regardless of programming language used, the POST or GET data must be properly formatted. While all our examples are in shell with curl command, it can be easily performed with all programming languages such as PHP, Python, Ruby, .Net, C, Java, etc.


API Response

Once you execute the above API call, you will receive either a success data or error data:

On error:

On success:

API Commands Reference

Please click the follow link to access the various different API commands that are available, including the syntax and error response codes for each command: