Code preference:
Curl
Ruby
Php
Python
Node.js
C#
Java

Migrating from API V1.0 to V2.0

With API V2.0, we have made authentication process, easy and simple. You need to download and use latest API 2.0 wrappers (for your choice of language). You also need to use V2.0 API Key from your API Console.

You can learn more on using API V2.0 wrappers here.

We have also deprecated few functions in API V1.0 which are no longer available in API V2.0. This was done to make output of these functions consistent with rest of the API functions and to make use of API by developers easy.

Following functions are available in API V1.0 only

This API call will let you access your created campaigns information.

a. To retrieve details of any particular campaign : get_campaign()

Input Parameter Description
id Unique Id of the campaign [Mandatory].

Example :

Not Applicable

Sample Output :

b. To retrieve details of all campaigns : get_campaigns()

Input Parameter Description
type Type of campaign. Possible values – classic, trigger, sms, template ( case sensitive ) [Optional].
status Status of campaign. Possible values – draft , sent, archive, queued, suspended, in_process, temp_active, temp_inactive ( case sensitive ) [Optional].
page Maximum number of records per request is 500, if there are more than 500 campaigns then you can use this parameter to get next 500 results [Optional].
page_limit This should be a valid number between 1-500 [Optional].

Example :

Not Applicable

Sample Output :

This API call will return the Campaign name, subject and share link of the classic type campaigns only which are sent, for those which are not sent and the rest of campaign types like trigger, template & sms, will return an error message of share link not available.

Input Parameter Description
campaign_ids Id of campaign to get share link. You can use commas to separate multiple ids [Mandatory].

Example :

Not Applicable

Sample Output:

This API call will let you access the account details and other information of the reseller child users.

Input Parameters Description
child_authkey 16 character authorization key of Reseller child. Example : To get the details of more than one child account, use, {“key1″:”abC01De2fGHI3jkL”,”key2″:”mnO45Pq6rSTU7vWX”} [Mandatory].

Example :

Not Applicable

Sample Output :

All the Reseller child account fields are explained below.

Output Parameters Description
api_key_name This is the API key name of child account
key This is the Access Key of child user
secret This is the Secret Key of child user
associated_ip This is the associated IP of child user
company This is the comapny name of child user
credit The email credits of the child account
current_month_total_sent This is the count of total emails sent in the current month
email The email of child user
fname The first name of child user
lname The last name of child user
password The encrypted password of child account
previous_month_total_sent This is the count of total emails sent in the previous month
total_sent This is the count of total emails sent by the child user till date

This API call will let you access all the processes information under the account.

This API does not require any input parameters.

Example :

Not Applicable

Sample Output :

This API call will let you access all the folders information under the account.

This API does not require any input parameters.

Example :

Not Applicable

Sample Output :

This API call will let you access all the list information under the account.

This API does not require any input parameters.

Example :

Not Applicable

Sample Output :