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

Account

Developers can access their account information as well as manage their reseller accounts using this API. Following are the various operations supported by this API.

This API call will let you access your account limits and other information.

API request returns the current plan details of the user along with their SMS plan details in case of success, in case of error it returns the error message.

This API does not require any input parameters.

Example :

Sample Output :

Output Parameters Description
plan_type Holds the plan type of the user viz. PAG (Pay As you Go), Unlimited, FREE and CREDIT_REC (Recurring Credit).
credits Remaining credits of the user. This can either be “User Limit” or “Send Limit” depending on the plan.
credit_type This is the type of the credit, “User Limit” or “Send Limit” are two possible types of credit of a user. “User Limit” implies the total number of subscribers you can add to your account, and “Send Limit” implies the total number of emails you can send to the subscribers in your account.

Note: “User Limit” and Unlimited plan type are deprecated. But still there are old existing users with this plan type. “User Limit” and Unlimited plan type might be interesting for them.

This API call is reserved only for Reseller Clients, it will let you create the Reseller child account. For more information about white label, please contact us.

Input Parameters Description
email Email address of Reseller child [Mandatory].
password Password of Reseller child to login [Mandatory].
company_org Name of Reseller child’s company [Mandatory].
first_name First name of Reseller child [Mandatory].
last_name Last name of Reseller child [Mandatory].
credits Number of email & sms credits respectively, which will be assigned to the Reseller child’s account [Optional].
associate_ip Associate dedicated IPs to reseller child. You can use commas to separate multiple IPs [Optional].

Example :

Sample Output :

This API call is reserved only for Reseller Clients, it will let you update the Reseller child account.

Input Parameters Description
child_authkey 16 character authorization key of Reseller child to be modified [Mandatory].
company_org Name of Reseller child’s company [Optional].
first_name First name of Reseller child [Optional].
last_name Last name of Reseller child [Optional].
password Password of Reseller child to login [Optional].
associate_ip Associate dedicated IPs to reseller child. You can use commas to separate multiple IPs [Optional].
disassociate_ip Disassociate dedicated IPs from reseller child. You can use commas to separate multiple IPs [Optional].

Example :

Sample Output:

This API is used to delete a reseller child account. It accepts the auth key for reseller child user account.

Input Parameters Description
child_authkey 16 character authorization key of Reseller child to be deleted [Mandatory].

Example :

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 :

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 add/remove the Email/Sms credits of the reseller child user. You can assign either email or sms credits, one at a time.

Input Parameters Description
childauthkey 16 character authorization key of Reseller child to modify credits [Mandatory].
add_credits Number of email & sms credits to be added. Email or sms credit added, one at a time [Mandatory: if remove_credits is empty].
remove_credits Number of email & sms credits to be removed. Email or sms credit removed, one at a time [Mandatory: if add_credits is empty].

Example :

Sample Output :
If reseller child has 0 email credits & Reseller has 9000 email credits, on successfully adding 1 email credit, you will get the following response.

This API call will let you access your SMTP details and other information.

API request returns the SMTP username and password along with the relay and port details.

This API does not require any input parameters.

Example :

Sample Output :