API Documentation Know more about Garuda - the intelligent mailer

Besides the existing integrations for different systems, with our powerful Garuda API you are able to create an integration with your own software. Synchronise all data from Garuda with the data from your own software to keep all information and your marketing campaigns up to date. The Marketing Email API provides developers with the ability to manage marketing emails, lists, email campaigns, and schedule delivery events. This can be very useful in allowing development teams to propagate data in and out of the web based Marketing Email App that can be easily used by members of the company with little or no programming expertise. The Marketing Email API is very similar to the Web API in that it follows the same convention and format, and utilises the same technology; HTTP requests. This is done with HTTP requests to the SendGrid site with a variety of parameters to organize data. All query responses can be provided in JSON.

URL Format

The following is the syntax for making API requests:

https://api.sendgrid.com/api/newsletter/[action].[format]

  • [action] - Each module supports multiple actions such as add, get, and update.
  • [message] - This determines the response format. It can be either json for a JSON response

Sample Request

$para = array("username" => "xMXSvVDAjmbdZrZtOAaE", "usertoken"=> "123", "module"=>"link", "action"=>"add", "name"=>'MTA Name', "url"=>'http://www.garudaim.com')

Sample Responce

{ "status": "success", "message": 10 }
Where 10 Is The Id Of New Inserted Link.

Responses

The format supported is JSON. Errors and success responses are described below while calls that provide information have their own return structure..

Errors

{ "status": "error", "message": ["...error messages..."] }

Success

{ "status": "success", "message": ["...success messages..."] }

Authentication

Each API call requires authentication. You must send the following HTTP parameters on your API calls. Your credentials are the same used for your SMTP authentication and/or website.

  • username - This is the API Key.
  • usertoken - This is the same password to authenticate over SMTP, and for logging into the website.
  • module - Name Of Module.
  • action - Action To be Perform On Module.

Possible Requests

This section will describe the different functions that can be used by the Interspire Email Marketer XML API. The XML document structure for ‘Adding a subscriber and associated custom details’ request is as follows:

1. User
Add User
request (Required).
  • module – "user". (Required)
  • action – "add". (Required)
  • user_name – User name for User. (Required)
  • password – Password for User. (Required)
  • usrgrp – Group Of User. (Required)
  • name – Name Of User. (Required)
  • timezone – Timezone. (Required)
  • mtagrp – MTA Group . (Required)
  • email – Email address of user. (Required)
Update User
request (Required).
  • module – "user". (Required)
  • action – "update". (Required)
  • uid – Id Of User To be Update. (Required)
  • password – Password for User. (Required)
  • usrgrp – Group Of User. (Required)
  • name – Name Of User. (Required)
  • timezone – Timezone. (Required)
  • mtagrp – MTA Group . (Required)
Delete User
request (Required).
  • module – "user". (Required)
  • action – "delete". (Required)
  • delid – Id Of User To be Delete. (Required)
Delete Multiple Users
request (Required).
  • module – "user". (Required)
  • action – "bulk_delete". (Required)
  • delete – Array Of Ids Of Users To be Delete. (Required)
Select a User By Id
request (Required).
  • module – "user". (Required)
  • action – "select". (Required)
  • id – Id Of User To be Select. (Required)
Select Multiple Users
request (Required).
  • module – "user". (Required)
  • action – "multiple_select". (Required)
2. User Group
Add User Group
request (Required).
  • module – "user group". (Required)
  • action – "add". (Required)
  • groupname – Name Of User Group. (Required)
  • setting_permission – Setting Related Permissions For User Group(0 or 1). (Required)
  • sendemail_permission – Send Email Campaign Permissions For User Group.(0 or 1) (Required)
  • user_permission – User Related Permissions For User Group.(0 or 1) (Required)
  • usergrp_permission – User Group Related Permissions For User Group.(0 or 1) (Required)
  • mta_permission – MTA Related Permissions For User Group.(0 or 1) (Required)
  • list_permission – List Permissions For User Group.(0, 1 or 2) (Required)
  • segment_permission – Segment Permissions For User Group.(0, 1 or 2) (Required)
  • template_permission – Template Permissions For User Group.(0, 1 or 2) (Required)
  • auto_permission – Autoresponder Permissions For User Group.(0, 1 or 2) (Required)
  • websiteform_permission – Website Form Permissions For User Group.(0, 1 or 2) (Required)
  • newsletter_permission – Email Campaign Permissions For User Group.(0, 1 or 2) (Required)
  • statistics_permission – Statistics Permissions For User Group.(0, 1 or 2) (Required)
  • contact_permission – Contacts Permissions For User Group.(0, 1 or 2) (Required)
  • trigger_permission – Triggers Permissions For User Group.(0, 1 or 2) (Required)
  • customfield_permission – Custom Field Permissions For User Group.(0, 1 or 2) (Required)
  • bannedemail_permission – Banned Email Permissions For User Group.(0, 1 or 2) (Required)
  • dynamiccontantadmin_permission – Dynamic Contant Permissions For User Group.(0, 1 or 2) (Required)
  • link_permission – Link Permissions For User Group.(0, 1 or 2) (Required)
Update User Group
request (Required).
  • module – "user group". (Required)
  • action – "update". (Required)
  • groupid – Id Of User Group To be Update. (Required)
  • groupname – Name Of User Group. (Required)
  • setting_permission – Setting Related Permissions For User Group(0 or 1). (Required)
  • sendemail_permission – Send Email Campaign Permissions For User Group.(0 or 1) (Required)
  • user_permission – User Related Permissions For User Group.(0 or 1) (Required)
  • usergrp_permission – User Group Related Permissions For User Group.(0 or 1) (Required)
  • mta_permission – MTA Related Permissions For User Group.(0 or 1) (Required)
  • list_permission – List Permissions For User Group.(0, 1 or 2) (Required)
  • segment_permission – Segment Permissions For User Group.(0, 1 or 2) (Required)
  • template_permission – Template Permissions For User Group.(0, 1 or 2) (Required)
  • auto_permission – Autoresponder Permissions For User Group.(0, 1 or 2) (Required)
  • websiteform_permission – Website Form Permissions For User Group.(0, 1 or 2) (Required)
  • newsletter_permission – Email Campaign Permissions For User Group.(0, 1 or 2) (Required)
  • statistics_permission – Statistics Permissions For User Group.(0, 1 or 2) (Required)
  • contact_permission – Contacts Permissions For User Group.(0, 1 or 2) (Required)
  • trigger_permission – Triggers Permissions For User Group.(0, 1 or 2) (Required)
  • customfield_permission – Custom Field Permissions For User Group.(0, 1 or 2) (Required)
  • bannedemail_permission – Banned Email Permissions For User Group.(0, 1 or 2) (Required)
  • dynamiccontantadmin_permission – Dynamic Contant Permissions For User Group.(0, 1 or 2) (Required)
  • link_permission – Link Permissions For User Group.(0, 1 or 2) (Required)
Delete User Group
request (Required).
  • module – "user group". (Required)
  • action – "delete". (Required)
  • groupdelid – Id Of User To be Delete. (Required)
Delete Multiple User Groups
request (Required).
  • module – "user group". (Required)
  • action – "bulk_delete". (Required)
  • delete – Array Of Ids Of Users Group To be Delete. (Required)
Select a User Group By Id
request (Required).
  • module – "user group". (Required)
  • action – "select". (Required)
  • id – Id Of User To be Select. (Required)
Select Multiple Users Groups
request (Required).
  • module – "user group". (Required)
  • action – "multiple_select". (Required)
3. Contact List
Add Contact List
request (Required).
  • module – "contact list". (Required)
  • action – "add". (Required)
  • listname – Name Of Contact List. (Required)
  • ownername – Ownername for Contact List. (Required)
  • owneremail – Owner Email Of Contact List. (Required)
  • cfield – Array Of Custom Field ids for Contact List. (Required)
  • notifyowner - Send subscribe and unsubscribe notification emails to the list owner (1 if Yes).
  • companyname - Company Name for Contact List.
  • companyaddress - Company Address for Contact List.
  • companyphone - Company Phone No. for Contact List.
Update Contact List
request (Required).
  • module – "contact list". (Required)
  • action – "update". (Required)
  • listid – Id Of List To be Update. (Required)
  • listname – Name Of Contact List. (Required)
  • ownername – Ownername for Contact List. (Required)
  • owneremail – Owner Email Of Contact List. (Required)
  • cfield – Array Of Custom Field ids for Contact List. (Required)
  • notifyowner - Send subscribe and unsubscribe notification emails to the list owner (1 if Yes).
  • companyname - Company Name for Contact List.
  • companyaddress - Company Address for Contact List.
  • companyphone - Company Phone No. for Contact List.
Delete Contact List
request (Required).
  • module – "contact list". (Required)
  • action – "delete". (Required)
  • del_id – Id Of Contact List To be Delete. (Required)
Delete Multiple Contact List
request (Required).
  • module – "contact list". (Required)
  • action – "bulk_delete". (Required)
  • delete – Array Of Ids Of Contact List To be Delete. (Required)
Copy Contact List
request (Required).
  • module – "contact list". (Required)
  • action – "copy". (Required)
  • copyid – Id Of Contact List To be Copy. (Required)
Select a Contact List By Id
request (Required).
  • module – "contact list". (Required)
  • action – "select". (Required)
  • id – Id Of Contact List To be Select. (Required)
Select Multiple Contact Lists
request (Required).
  • module – "contact list". (Required)
  • action – "multiple_select". (Required)
4. Contacts
Add Contacts
request (Required).
  • module – "contacts". (Required)
  • action – "add". (Required)
  • list – Id Of Contact List. (Required)
  • sub – Subscription Status(0 for Subscribe and 1 for Unsubscribe). (Required)
  • field['emailaddress'] – Email Address Of Contact. (Required)
  • field['format'] - Formate Of Email (h for html and t for text).(Required)
  • field['confirmed'] - Confirmation Status for Contact(1 for Confirmed and 0 for Unconfirmed).(Required)
  • field – Array Of Fields Of given list(eg. field[1] => 01/07/2015 [2] => India).
Update Contact
request (Required).
  • module – "contacts". (Required)
  • action – "update". (Required)
  • subid – Id Of Contact To be Update. (Required)
  • list – Id Of Contact List. (Required)
  • sub – Subscription Status(0 for Subscribe and 1 for Unsubscribe). (Required)
  • field['emailaddress'] – Email Address Of Contact. (Required)
  • field['format'] - Formate Of Email (h for html and t for text).(Required)
  • field['confirmed'] - Confirmation Status for Contact(1 for Confirmed and 0 for Unconfirmed).(Required)
  • field – Array Of Fields Of given list(eg. field[1] => 01/07/2015 [2] => India).
and required fields of given list in field array.
Delete Contact
request (Required).
  • module – "contacts". (Required)
  • action – "delete". (Required)
  • contact_id – Id Of Contact To be Delete. (Required)
  • list – Id Of Contact List Of Contact. (Required)
Delete Multiple Contact
request (Required).
  • module – "contacts". (Required)
  • action – "bulk_delete". (Required)
  • list – Id Of Contact List Of Contacts. (Required)
  • delete – Array Of Ids Of Contact To be Delete. (Required)
Select Contact By Id
request (Required).
  • module – "contacts". (Required)
  • action – "select". (Required)
  • id – Id Of Contact To be Select. (Required)
  • lid – Id Of Contact List Of Contact. (Required)
Select Multiple Contacts
request (Required).
  • module – "contacts". (Required)
  • action – "multiple_select". (Required)
  • lid – Id Of Contact List Of Contacts. (Required)
5.Custom Fields
Add Custom Fields
request (Required).
  • module – "custom field". (Required)
  • action – "add". (Required)
  • fieldtype – Type Of Custom Field(eg Text Field,Text Area,Numbers Only,Select Box,Checkboxs,Radio Buttons,Date Field,). (Required)
  • fieldname – Name Of Custom Field. (Required)
  • lists – Array Of Contact List Ids For Custom Field. (Required)
  • isrequired – Is This Custom Field Required?(1 if yes).
  • defaultvalue – Default Field for Custom Field.
  • applydefault – apply the default value to existing contacts in the contact list(s)?(1 if yes).
  • fieldlenght – Field Length Of Custom field.
  • maxlenght – Maximum Length Of Custom field .
  • minlenght – Minimum Length For Custom Field.
  • isglobal – Is This Custom Field Global?(1 if yes).
Update Custom Field
request (Required).
  • module – "custom field". (Required)
  • action – "update". (Required)
  • cfid – Id Of Custom Field To be Update. (Required)
  • fieldname – Name Of Custom Field. (Required)
  • lists – Array Of Contact List Ids For Custom Field. (Required)
  • isrequired – Is This Custom Field Required?(1 if yes).
  • isglobal – Is This Custom Field Global?(1 if yes).
Delete Custom Field
request (Required).
  • module – "custom field". (Required)
  • action – "delete". (Required)
  • del_id – Id Of Custom Field To be Delete. (Required)
Delete Multiple Custom Fields
request (Required).
  • module – "custom field". (Required)
  • action – "bulk_delete". (Required)
  • delete – Array Of Ids Of Custom Fields To be Delete. (Required)
Select a Custom Fields By Id
request (Required).
  • module – "custom field". (Required)
  • action – "select". (Required)
  • id – Id Of Custom Fields To be Select. (Required)
Select Multiple Custom Fields
request (Required).
  • module – "custom field". (Required)
  • action – "multiple_select". (Required)
6.Segments
Add Segments
request (Required).
  • module – "segment". (Required)
  • action – "add". (Required)
  • sname – Name OF Segment. (Required)
  • lists – Array Of List Ids For Segment . (Required)
  • match – Maching Type For Segment(and,or). (Required)
  • fieldrules – Name Of Filter(emailaddress,format,confirmed,status,subscribedate,link,campaign).(Required)
  • type – Filter Type According To fieldrules(eg. is,=,<>).(Required)
  • inputdata – Filter Value According To type and fieldrules.(Required)
Update Segments
request (Required).
  • module – "segment". (Required)
  • action – "update". (Required)
  • segmentid – Id Of Custom Field To be Update. (Required)
  • sname – Name OF Segment. (Required)
  • lists – Array Of List Ids For Segment . (Required)
  • match – Maching Type For Segment(and,or). (Required)
  • fieldrules – Name Of Filter(emailaddress,format,confirmed,status,subscribedate,link,campaign).(Required)
  • type – Filter Type According To fieldrules(eg. is,=,<>).(Required)
  • inputdata – Filter Value According To type and fieldrules.(Required)
Delete Segment
request (Required).
  • module – "segment". (Required)
  • action – "delete". (Required)
  • del_sid – Id Of Segment To be Delete. (Required)
Delete Multiple Segments
request (Required).
  • module – "segment". (Required)
  • action – "bulk_delete". (Required)
  • delete – Array Of Ids Of Segments To be Delete. (Required)
Copy Segment
request (Required).
  • module – "segment". (Required)
  • action – "copy". (Required)
  • copyid – Id Of Segment To be Copy. (Required)
Select a Segment By Id
request (Required).
  • module – "segment". (Required)
  • action – "select". (Required)
  • id – Id Of Segment To be Select. (Required)
Select Multiple Segments
request (Required).
  • module – "segment". (Required)
  • action – "multiple_select". (Required)
7.Email Campaign
Add Email Campaign
request (Required).
  • module – "email campaign". (Required)
  • action – "add". (Required)
  • subject – Subject Of Email Campaign. (Required)
  • campaign_format – Formate Of Email Campaign(h for HTML , t For Text).(Required)
  • campaign_name – Name Of Email Campaign. (Required)
  • templates – Id Of Email Template For Email Campaign.(Required)
  • sub – Subject rotation ?(1 if Yes).
  • active – Activate Email Campaign?(1 if Yes).
  • archive – Archive Email Campaign?(1 if Yes).
  • htmldata – HTML Content.(Required If campaign_format is h)
  • textdata – Text Content.(Required If campaign_format is t)
Update Email Campaign
request (Required).
  • module – "email campaign". (Required)
  • action – "update". (Required)
  • newsid – Id Of Email Campaign To be Update. (Required)
  • campaign_format – Formate Of Email Campaign(h for HTML , t For Text).(Required)
  • campaign_name – Name Of Email Campaign. (Required)
  • templates – Id Of Email Template For Email Campaign.(Required)
  • sub – Subject rotation ?(1 if Yes).
  • active – Activate Email Campaign?(1 if Yes).
  • archive – Archive Email Campaign?(1 if Yes).
  • htmldata – HTML Content.(Required If campaign_format is h)
  • textdata – Text Content.(Required If campaign_format is t)
Delete Email Campaign
request (Required).
  • module – "email campaign". (Required)
  • action – "delete". (Required)
  • campaign_id – Id Of Email Campaign To be Delete. (Required)
Delete Multiple Email Campaign
request (Required).
  • module – "email campaign". (Required)
  • action – "bulk_delete". (Required)
  • delete – Array Of Ids Of Email Campaign To be Delete. (Required)
Copy Email Campaign
request (Required).
  • module – "email campaign". (Required)
  • action – "copy". (Required)
  • copyid – Id Of Email Campaign To be Copy. (Required)
Select a Email Campaign By Id
request (Required).
  • module – "email campaign". (Required)
  • action – "select". (Required)
  • id – Id Of Email Campaign To be Select. (Required)
Select Multiple Email Campaign
request (Required).
  • module – "email campaign". (Required)
  • action – "multiple_select". (Required)
8.Trigger
Add Trigger
request (Required).
  • module – "trigger". (Required)
  • action – "add". (Required)
  • triggername – Name Of Trigger. (Required)
  • radio – Activate Trigger Base(f for contact's date field, s for specific date, l for link being clicked , n for email campaign being opened).(Required)
  • when – Actions On Trigger(-1 For Before Date,0 For On Date, 1 For After Date).(Required)
  • interval – Interval According to action(0 for The Date , 1 for The Next Anniversary Of The Date). (Required)
  • tday – Number Of Day(s),Hour(s) or Week(s).(Required if Actions On Trigger Is Not On Date)
  • hrs – 1 For Hours,24 For Days,168 For Weeks.(Required if Actions On Trigger Is Not On Date)
  • list1 – Id Of List.(Required If Activate Trigger Is Based on a contact's date field)
  • datecal – specific Date(Formate 2015:06:18).(Required If Activate Trigger Is Based on specific date)
  • check – Array Of Ids Of Contact Lists.(Required If Activate Trigger Is Based on specific date)
  • list2 – Id Of Email Campaign.(Required If Activate Trigger Is Based on link being clicked )
  • linkfield – Id Of Link.(Required If Activate Trigger Is Based on link being clicked )
  • list2 – Id Of Email Campaign.(Required If Activate Trigger Is Based on email campaign being opened )
  • sendemailcamp – Send An Email Campaign When Triggered(1 if Yes).
  • list4 – Id Of Email Campaign.(Required If sendemailcamp Is 1)
  • sendfromname – Name Of Sender.(Required If sendemailcamp Is 1)
  • sendfromemail – Email Id Of Sender.(Required If sendemailcamp Is 1)
  • replytoemail – Email Id To Send Replay.(Required If sendemailcamp Is 1)
  • addtolist – Add the contact to an additional contact list (1 if Yes).
  • triggercheck – Array Of Contact Lists.(Required If addtolist Is 1)
  • removefrom – Remove the contact List (1 if Yes).
  • active – Is Trigger Active? (1 if Yes).
  • multipart – Send Your Email as Multipart??(1 if Yes).
  • trackopenrate – Track Open Rates for HTML Emails??(1 if Yes).
  • tracklink – Track Links Clicked in this Email?(1 if Yes).
  • embedimage – Embed Images as Attachments?(1 if Yes).
Update Trigger
request (Required).
  • module – "trigger". (Required)
  • action – "update". (Required)
  • id – Id Of Trigger To be Update. (Required)
  • triggername – Name Of Trigger. (Required)
  • radio – Activate Trigger Base(f for contact's date field, s for specific date, l for link being clicked , n for email campaign being opened).(Required)
  • when – Actions On Trigger(-1 For Before Date,0 For On Date, 1 For After Date).(Required)
  • interval – Interval According to action(0 for The Date , 1 for The Next Anniversary Of The Date). (Required)
  • tday – Number Of Day(s),Hour(s) or Week(s).(Required if Actions On Trigger Is Not On Date)
  • hrs – 1 For Hours,24 For Days,168 For Weeks.(Required if Actions On Trigger Is Not On Date)
  • list1 – Id Of List.(Required If Activate Trigger Is Based on a contact's date field)
  • datecal – specific Date(Formate 2015:06:18).(Required If Activate Trigger Is Based on specific date)
  • check – Array Of Ids Of Contact Lists.(Required If Activate Trigger Is Based on specific date)
  • list2 – Id Of Email Campaign.(Required If Activate Trigger Is Based on link being clicked )
  • linkfield – Id Of Link.(Required If Activate Trigger Is Based on link being clicked )
  • list2 – Id Of Email Campaign.(Required If Activate Trigger Is Based on email campaign being opened )
  • sendemailcamp – Send An Email Campaign When Triggered(1 if Yes).
  • list4 – Id Of Email Campaign.(Required If sendemailcamp Is 1)
  • sendfromname – Name Of Sender.(Required If sendemailcamp Is 1)
  • sendfromemail – Email Id Of Sender.(Required If sendemailcamp Is 1)
  • replytoemail – Email Id To Send Replay.(Required If sendemailcamp Is 1)
  • addtolist – Add the contact to an additional contact list (1 if Yes).
  • triggercheck – Array Of Contact Lists.(Required If addtolist Is 1)
  • removefrom – Remove the contact List (1 if Yes).
  • active – Is Trigger Active? (1 if Yes).
  • multipart – Send Your Email as Multipart??(1 if Yes).
  • trackopenrate – Track Open Rates for HTML Emails??(1 if Yes).
  • tracklink – Track Links Clicked in this Email?(1 if Yes).
  • embedimage – Embed Images as Attachments?(1 if Yes).
Delete Trigger
request (Required).
  • module – "trigger". (Required)
  • action – "delete". (Required)
  • triggerid – Id Of Trigger To be Delete. (Required)
Multiple Trigger Action
request (Required).
  • module – "trigger". (Required)
  • action – "bulk_action". (Required)
  • multi_action – Action To Be Perform(deletesellist,active,deactive). (Required)
  • deleteall – Array Of Trigger Ids To Perform Action. (Required)
Copy Trigger
request (Required).
  • module – "trigger". (Required)
  • action – "copy". (Required)
  • copyid – Id Of Trigger To be Copy. (Required)
Change Trigger Status By Id
request (Required).
  • module – "trigger". (Required)
  • action – "change_status". (Required)
  • id – Id Of Trigger To Change Status. (Required)
Select a Trigger By Id
request (Required).
  • module – "trigger". (Required)
  • action – "select". (Required)
  • id – Id Of Trigger To be Select. (Required)
Select Multiple Trigger
request (Required).
  • module – "trigger". (Required)
  • action – "multiple_select". (Required)
9.Template
Add Template
request (Required).
  • module – "custom_template". (Required)
  • action – "add". (Required)
  • tname – Subject Of Template. (Required)
  • format – Formate Of Template(h for HTML , t For Text).(Required)
  • templates – Name Of Template. (Required)
  • htmldata – HTML Content.(Required If formate is h)
  • textdata – Text Content.(Required If formate is t)
  • desc – Discription(1 if Yes).
  • active – Activate Template?(1 if Yes).
  • global – Global Template?(1 if Yes).
Update Template
request (Required).
  • module – "custom_template". (Required)
  • action – "update". (Required)
  • tempid – Id Of Email Campaign To be Update. (Required)
  • tname – Subject Of Template. (Required)
  • format – Formate Of Template(h for HTML , t For Text).(Required)
  • templates – Name Of Template. (Required)
  • htmldata – HTML Content.(Required If formate is h)
  • textdata – Text Content.(Required If formate is t)
  • desc – Discription(1 if Yes).
  • active – Activate Template?(1 if Yes).
  • global – Global Template?(1 if Yes).
Delete Template
request (Required).
  • module – "custom_template". (Required)
  • action – "delete". (Required)
  • template_id – Id Of Template To be Delete. (Required)
Delete Multiple Template
request (Required).
  • module – "custom_template". (Required)
  • action – "bulk_delete". (Required)
  • deleteall – Array Of Ids Of Template To be Delete. (Required)
Copy Template
request (Required).
  • module – "custom_template". (Required)
  • action – "copy". (Required)
  • copyid – Id Of Template To be Copy. (Required)
Change Template Status
request (Required).
  • module – "custom_template". (Required)
  • action – "change_status". (Required)
  • template_id – Id Of Template To Change Status. (Required)
Change Global Template
request (Required).
  • module – "custom_template". (Required)
  • action – "change_global". (Required)
  • template_id – Id Of Template To Change Global. (Required)
Select a Template By Id
request (Required).
  • module – "custom_template". (Required)
  • action – "select". (Required)
  • id – Id Of Template To be Select. (Required)
Select Multiple Template
request (Required).
  • module – "custom_template". (Required)
  • action – "multiple_select". (Required)
10.Link
Add Link
request (Required).
  • module – "link". (Required)
  • action – "add". (Required)
  • name – Name Of Link.(Required)
  • url – URL Of Link.(Required)
Update Link
request (Required).
  • module – "link". (Required)
  • action – "update". (Required)
  • linkid – Id Of Link To be Update. (Required)
  • action – "add". (Required)
  • name – Name Of Link.(Required)
  • url – URL Of Link.(Required)
Delete Link
request (Required).
  • module – "link". (Required)
  • action – "delete". (Required)
  • link_id – Id Of Link To be Delete. (Required)
Delete Multiple Link
request (Required).
  • module – "link". (Required)
  • action – "bulk_delete". (Required)
  • delete – Array Of Ids Of Link To be Delete. (Required)
Select a Link By Id
request (Required).
  • module – "link". (Required)
  • action – "select". (Required)
  • id – Id Of Link To be Select. (Required)
Select Multiple Template
request (Required).
  • module – "link". (Required)
  • action – "multiple_select". (Required)
11.MTA Group
Add MTA Group
request (Required).
  • module – "mta_group". (Required)
  • action – "add". (Required)
  • mta_name – Name Of MTA Group.(Required)
  • mta_description – Discription Of MTA Group.(Required)
  • mta_field – Array Of MTA Ids.(Required)
Update MTA Group
request (Required).
  • module – "mta_group". (Required)
  • action – "update". (Required)
  • mta_group_id – Id Of MTA Group To be Update. (Required)
  • mta_name – Name Of MTA Group.(Required)
  • mta_description – Discription Of MTA Group.(Required)
  • mta_field – Array Of MTA Ids.(Required)
Delete MTA Group
request (Required).
  • module – "mta_group". (Required)
  • action – "delete". (Required)
  • mta_group_id – Id Of MTA Group To be Delete. (Required)
Delete Multiple MTA Group
request (Required).
  • module – "mta_group". (Required)
  • action – "bulk_delete". (Required)
  • deleteall – Array Of Ids Of MTA Group To be Delete. (Required)
Select a MTA Group By Id
request (Required).
  • module – "mta_group". (Required)
  • action – "select". (Required)
  • id – Id Of MTA Group To be Select. (Required)
Select Multiple MTA Group
request (Required).
  • module – "mta_group". (Required)
  • action – "multiple_select". (Required)
12.MTA
Add MTA
request (Required).
  • module – "mta". (Required)
  • action – "add". (Required)
  • fromname – From Name.(Required)
  • fromemail – From Email.(Required)
  • smtp_server_name – Server Name.(Required)
  • bounce_email – Bounce Email/ Return Path Email.(Required)
  • cust_transport_check – For Custom Transport(1 If Yes). (Required)
  • cust_transport – Custom Transport.
  • emailperhour – Unlimited Email Per Minutes(1 If Yes).(Required)
  • maxemailperhour – Number Of Emails Per Hours.(Required If emailperhour is 0)
  • emailperday – Unlimited Email Per Day(1 If Yes).(Required)
  • maxemailperday – Number Of Emails Per Day.(Required)
  • forcefrom – Force From.(Required)
  • process_bounce_check – "add".
  • bhostname – Bounce Hostname.(Required If process_bounce_check Is 1)
  • buser – Bounce User(1 If Yes).(Required If process_bounce_check Is 1)
  • bpass – Bounce Password.(Required If process_bounce_check Is 1)
  • bport – Bounce port.(Required If process_bounce_check Is 1)
  • advancedsettingbounce – Autodetect advanced settings (recommended).(Required If process_bounce_check Is 1)
  • acc_type_bounce – Account Type(0 for POP3 Account,1 for IMAP Account).(Required If process_bounce_check Is 1)
  • bounce_empty_inbox – Empty Bounce When Done.
  • smtp_host_name – SMTP Hostname.(Required If cust_transport_check Is NOt 1)
  • asmtp_u – "add".
  • asmtp_pwd – From Name.
  • asmtp_port – From Email.
  • blockdomain – Server Name.
  • trackdomain – Track Domain.
  • status – Active(1 If Yes).
  • process_fbl_check – Process Fbl(1 If Yes).
  • fblhostname – FBL Hostname.(Required If process_fbl_check Is 1)
  • fblhostname – FBL User.
  • fpass – FBL Password.
  • fport – FBL port.
  • fblemail – FBL Email.
  • advancesettingfbl – Advanced Setting(validate-cert,advancesettingfbl,advancesettingfbl,advancesettingfbl).
  • fbl_empty_inbox – Empty Feedback Loops When Done(1 If Yes).
Update MTA
request (Required).
  • module – "mta". (Required)
  • action – "update". (Required)
  • mtaid – Id Of MTA Group To be Update. (Required)
  • fromname – From Name.(Required)
  • fromemail – From Email.(Required)
  • smtp_server_name – Server Name.(Required)
  • bounce_email – Bounce Email/ Return Path Email.(Required)
  • cust_transport_check – For Custom Transport(1 If Yes). (Required)
  • cust_transport – Custom Transport.
  • emailperhour – Unlimited Email Per Minutes(1 If Yes).(Required)
  • maxemailperhour – Number Of Emails Per Hours.(Required If emailperhour is 0)
  • emailperday – Unlimited Email Per Day(1 If Yes).(Required)
  • maxemailperday – Number Of Emails Per Day.(Required)
  • forcefrom – Force From.(Required)
  • process_bounce_check – "add".
  • bhostname – Bounce Hostname.(Required If process_bounce_check Is 1)
  • buser – Bounce User(1 If Yes).(Required If process_bounce_check Is 1)
  • bpass – Bounce Password.(Required If process_bounce_check Is 1)
  • bport – Bounce port.(Required If process_bounce_check Is 1)
  • advancedsettingbounce – Autodetect advanced settings (recommended).(Required If process_bounce_check Is 1)
  • acc_type_bounce – Account Type(0 for POP3 Account,1 for IMAP Account).(Required If process_bounce_check Is 1)
  • bounce_empty_inbox – Empty Bounce When Done.
  • smtp_host_name – SMTP Hostname.(Required If cust_transport_check Is NOt 1)
  • asmtp_u – "add".
  • asmtp_pwd – From Name.
  • asmtp_port – From Email.
  • blockdomain – Server Name.
  • trackdomain – Track Domain.
  • status – Active(1 If Yes).
  • process_fbl_check – Process Fbl(1 If Yes).
  • fblhostname – FBL Hostname.(Required If process_fbl_check Is 1)
  • fblhostname – FBL User.
  • fpass – FBL Password.
  • fport – FBL port.
  • fblemail – FBL Email.
  • advancesettingfbl – Advanced Setting(validate-cert,advancesettingfbl,advancesettingfbl,advancesettingfbl).
  • fbl_empty_inbox – Empty Feedback Loops When Done(1 If Yes).
Change Status Of MTA By Id
request (Required).
  • module – "mta". (Required)
  • action – "change_status". (Required)
  • mta_id – Id Of MTA To Change Status. (Required)
Delete MTA
request (Required).
  • module – "mta". (Required)
  • action – "delete". (Required)
  • mta_id – Id Of MTA To be Delete. (Required)
Delete Multiple MTA
request (Required).
  • module – "mta". (Required)
  • action – "bulk_delete". (Required)
  • mta_ids – Array Of Ids Of MTA To be Delete. (Required)
Select a MTA By Id
request (Required).
  • module – "mta". (Required)
  • action – "select". (Required)
  • id – Id Of MTA To be Select. (Required)
Select Multiple MTA Group
request (Required).
  • module – "mta". (Required)
  • action – "multiple_select". (Required)