GetLists

Calls up all the Lists that this user either owns or has access to.

Parametres

This method does not have any parameters.

Returns:

On success:

<Array> Lists details

On failure:

<Boolean> false

Examples:

$ http GET "https://api.mailmailmail.net/v1.1/Users/GetLists?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN"

object result = parser.GetLists();

CreateList

This method creates a List based on current class variables.

Parametres:

• <String> listName – Name of the List. [Required]
• <String> descriptiveName – List description. [Required]
• <String> mobilePrefix – Country dialing code.
• <Array>  contactFields - Comma separated list of Contact Fields id related to this Contact List.

CreateList(listName, descriptiveName, mobilePrefix, contactFields)

$ http POST https://api.mailmailmail.net/v1.1/Lists/CreateList --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&listName=value&descriptiveName=value&mobile_prefix=value&contact_fields=value"

Returns:

On success:

<Integer> listid

On failure:

<Boolean> false

Examples:

$ http POST https://api.mailmailmail.net/v1.1/Lists/CreateList --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&listName=List%name&descriptiveName=List%description&mobile_prefix=389&contact_fields[0]=1&contact_fields[1]=2"

string listName = "List name";
string descriptiveName = "List description";
string mobilePrefix = "389";
int[] contactFields = new int[] {1, 2};

object result = parser.CreateList(listName, descriptiveName, mobilePrefix, contactFields);

AddCustomFieldsToList

This method add custom fields to specific list.

Parametres:

• <String> listid – ID of the list. [Required]
• <Array>  customFields - List of custom fields ids. [Required]

AddCustomFieldsToList(listid, customFields)

$ http POST https://api.mailmailmail.net/v1.1/Lists/AddCustomFieldsToList --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&listid=value&customFields=value"

Returns:

On success:

<Array> (true, message)

On failure:

<Array> (false, message)

Examples:

$ http POST https://api.mailmailmail.net/v1.1/Lists/AddCustomFieldsToList --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&listid=156&customFields[0]=1&customFields[1]=2"

int listid = 156;
int[] customFields = new int[] {1, 2};

object result = parser.AddCustomFieldsToList(listid, customFields);

UpdateList

Updates a current List based on the current class variables.

Parametres:

• <Integer> listid – ID of the list to be edited. [Required]
• <String> listName – New name of the list.
• <String> descriptiveName – New list description.
• <String> mobilePrefix – New country dialing code.

 UpdateList(listid, listName, descriptiveName, mobilePrefix);

$ http POST https://api.mailmailmail.net/v1.1/Lists/UpdateList --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&listid=value&listName=value&descriptiveName=value&mobile_prefix=value"

Returns:

On success:

<Boolean> true

On failure:

<Boolean> false

Examples:

$ http POST https://api.mailmailmail.net/v1.1/Lists/UpdateList --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&listid=12&listName=List%new%name&descriptiveName=New%Description"

int listid = 12;
string listName = "List new name";
string descriptiveName = "New Description";

object result = parser.UpdateList(listid, listName, descriptiveName);

CopyList

Copy List details including contact fields.

Parametres:

• <Integer> listid – ID of List to be copied. [Required]

CopyList(listid);

$ http POST https://api.mailmailmail.net/v1.1/Lists/CopyList --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&listid=value"

Returns:

On success:

<Integer> new id

On failure:

<Array> {“false”, message}

Examples:

$ http POST https://api.mailmailmail.net/v1.1/Lists/CopyList --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&listid=12"

int listid = 12;

object result = parser.CopyList(listid);

DeleteList

Delete a List from the database.

Parametres:

• <Integer> listid – List ID of the List to be deleted. [Required]

 DeleteList(listid);

$ http DELETE 'https://api.mailmailmail.net/v1.1/Lists/DeleteList' -d 'listid=value&Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN'

Returns:

On success:

<Boolean> true

On failure:

<String> message

Examples:

$ http DELETE 'https://api.mailmailmail.net/v1.1/Lists/DeleteList' -d 'listid=12&Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN'

int listid = 12;

object result = parser.DeleteList(listid);

CreateCustomField

Create new custom field.

Parametres:

• <String> fieldName – Name of custom field. [Required]
• <Object> customField – Custom field object. text / textarea / number / dropdown / checkbox / radiobutton / date [Required]
• <Array> listids – List ID(s) of the list to be added custom field

CreateCustomField(fieldName, customField, listids);

$ http POST https://api.mailmailmail.net/v1.1/CustomFields/CreateCustomField --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&name=value&fieldtype=value&fieldsettings=value&listids=value"

Returns:

On success:

 <Integer> Return id of new custom field.

On failure:

<Array> (false, message)

Examples:

$ http POST https://api.mailmailmail.net/v1.1/CustomFields/CreateCustomField --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&name=Text%field&fieldtype=text&fieldsettings[MaxLength]=500"

ContactFieldText customField = new ContactFieldText();
customField.fieldSettings["MaxLength"] = "500";
object responce = parser.CreateCustomField(fieldName, customField);

ContactFieldTextArea customField = new ContactFieldTextArea();
customField.fieldSettings["Rows"] = "10";
int[] listids = new int[] { 48 };
object responce = parser.CreateCustomField(fieldName, customField, listids);

ContactFieldNumber customField = new ContactFieldNumber();
customField.fieldSettings["MaxLength"] = "100";
int[] listids = new int[] { 48,49 };
object responce = parser.CreateCustomField(fieldName, customField, listids);

ContactFieldDropdown customField = new ContactFieldDropdown();

List keys = new List();

keys.Add("green");
keys.Add("blue");

List values = new List();

values.Add("green");
values.Add("blue");

customField.fieldSettings["Key"] = keys;
customField.fieldSettings["Value"] = values;

object responce = parser.CreateCustomField(fieldName, customField);

ContactFieldRadioButton customField = new ContactFieldRadioButton();

List keys = new List();

keys.Add("male");
keys.Add("female");

List values = new List();

values.Add("male");
values.Add("female");

customField.fieldSettings["Key"] = keys;
customField.fieldSettings["Value"] = values;

object responce = parser.CreateCustomField(fieldName, customField);

ContactFieldCheckBox customField = new ContactFieldCheckBox();

List keys = new List();

keys.Add("active");
       
List values = new List();

values.Add("active");
       
customField.fieldSettings["Key"] = keys;
customField.fieldSettings["Value"] = values;

object responce = parser.CreateCustomField(fieldName, customField);

ContactFieldDate customField = new ContactFieldDate();

customField.fieldSettings["format_1"] = "day";
customField.fieldSettings["format_2"] = "month";
customField.fieldSettings["format_3"] = "year";
customField.fieldSettings["start_year"] = "2011";
customField.fieldSettings["end_year"] = "2055";

object responce = parser.CreateCustomField(fieldName, customField);

ContactFieldDate customField = new ContactFieldDate();

object responce = parser.CreateCustomField(fieldName, customField);

ContactFieldDate customField = new ContactFieldDate();

customField.fieldSettings["format_1"] = "month";
customField.fieldSettings["format_2"] = "day";
customField.fieldSettings["format_3"] = "year";

object responce = parser.CreateCustomField(fieldName, customField);

ContactFieldDate customField = new ContactFieldDate();

customField.fieldSettings["format_1"] = "year";
customField.fieldSettings["format_2"] = "month";
customField.fieldSettings["format_3"] = "day";

object responce = parser.CreateCustomField(fieldName, customField);

LoadCustomField

Loads up the customfield and sets the appropriate class variables.

Parametres:

• <Integer> fieldid – The fieldid to load up.
• <Boolean> returnOptions – Whether to return the information loaded from the database or not.
• <Boolean> makeInstance – Will return false if the fieldid is not present, or thefield can't be found, otherwise it set the class vars, associations and options and return true.

 LoadCustomField(fieldid, returnOptions, makeInstance);

$ http GET "https://api.mailmailmail.net/v1.1/CustomFields/LoadCustomField?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&fieldid=value&return_options=value&makeInstance=value"

Returns:

On success:

 <Array> Returns custom field.

On failure:

<Boolean> false.

Examples:

$ http GET "https://api.mailmailmail.net/v1.1/CustomFields/LoadCustomField?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&fieldid=12"

int fieldid = 12;

object responce = parser.LoadCustomField(fieldid);

GetCustomFields

Fetches Contact Fields for the specified List.

Parametres:

• <Array> listids – This is used to restrict from which Lists this information will be fetched.

 GetCustomFields(listids);

$ http GET "https://api.mailmailmail.net/v1.1/Lists/GetCustomFields?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&listids=value"

Returns:

On success:

 <List<ContactFieldText>> Returns the List of Contact Fields.

On failure:

<Array> Empty array.

Examples:

$ http GET "https://api.mailmailmail.net/v1.1/Lists/GetCustomFields?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&listids[0]=1&listids[1]=2&listids[2]=3"

int[] listids = new int[] { 1, 2, 3 };

object result = parser.GetCustomFields(listids);

GetSampleDataForOTM

Get sample data for OtM field.

Parametres:

• <Integer> fieldid – ID of field. [Required]

GetSampleDataForOTM(fieldid);

$ http GET "https://api.mailmailmail.net/v1.1/Subscribers/GetSampleDataForOTM?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&fieldid=value"

Returns:

On success:

<Array> Returns sample data.

On failure:

<Boolean> false.

Examples:

$ http GET "https://api.mailmailmail.net/v1.1/Subscribers/GetSampleDataForOTM?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&fieldid=78"

int fieldid = 78;

object result = parser.GetSampleDataForOTM(fieldid);

AddSubscriberToList

This method adds subscriber to contact List. Please note that adding a profile that is already on a list as an unsubscribed will result in sending out a confirmation email.

Parametres:

• <SubscriberObj>  subscriber – Subscriber to add. [Required]
• Note: If status is unconfirmed, confirmation email will be sent to the subscriber.
• <List<ContactFieldText>>  contactFields – Subscriber Contact Fields.
• <Dictionary>  otmValues – The values you want to add into OTM field.
• <String> Key
• <Object> Value

AddSubscriberToList(subscriber, contactFields, otmValues);

$ http POST https://api.mailmailmail.net/v1.1/Subscribers/AddSubscriberToList --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&listid=value&emailaddress=value&mobile=value&mobilePrefix=value&contactFields=value&add_to_autoresponders=value&skip_listchek=value&confirmed=value&otmValues=value"

Returns:

On success:

<Integer> System ID of the Subscriber.

On failure:

<Boolean> false

Examples:

$ http POST https://api.mailmailmail.net/v1.1/Subscribers/AddSubscriberToList --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&listid=110&emailaddress=test@mail.net"

SubscriberObj subscriber = new SubscriberObj();
subscriber.emailaddress = "test@c.asp";
subscriber.mobile = "070444555";
subscriber.mobilePrefix = "389";
subscriber.listid = 110;
subscriber.addToAutoresponders = false;
subscriber.skipListCheck = false;
subscriber.confirmed = "1";

object result = parser.AddSubscriberToList(subscriber);

List contactFields = new List();
ContactFieldText city = new ContactFieldText();
city.fieldid = 8;
string[] value1 = new string[] { "Kumanovo" };
city.fieldvalue = value1;
contactFields.Add(city);
     
ContactFieldText birthDate = new ContactFieldText();
birthDate.fieldid = 7;
string[] value3 = new string[] { "19/03/2016" };
birthDate.fieldvalue = value3;
contactFields.Add(birthDate);
        
object result = parser.AddSubscriberToList(subscriber, contactFields);

Contact fields for checkbox:

ContactFieldText weekdays = new ContactFieldText();
weekdays.fieldid = 52;
string[] value2 = new string[] { "Sat", "Sun" };
weekdays.fieldvalue = value2;
contactFields.Add(weekdays);

object result = parser.AddSubscriberToList(subscriber, contactFields);

Field structure:

SubscriberObj subscriber = new SubscriberObj();
subscriber.emailaddress = "test@mail.net";
subscriber.listid = 79;
List<Dictionary<string, object>> otmValues = new List<Dictionary<string, object>>();
Dictionary<string, object> movie = new Dictionary<string, object>();
Dictionary<string, object>movies = new Dictionary<string, object>();
List<Dictionary<string, object>> actors = new List<Dictionary<string, object>>();
List<Dictionary<string, object>> premieres = new List<Dictionary<string, object>>();

Dictionary actor1 = new Dictionary();
actor1.Add("FirstName", "Rami");
actor1.Add("LastName", "malek");
actor1.Add("BirthDate", "12.05.1981");
actor1.Add("emp_trigger", 1);

Dictionary actor2 = new Dictionary();
actor2.Add("FirstName", "Lucy");
actor2.Add("LastName", "Boynton");
actor2.Add("BirthDate", "17.01.1994");
actor2.Add("emp_trigger", 1);

actors.Add(actor1);
actors.Add(actor2);

Dictionary premiere1 = new Dictionary();
premiere1.Add("Country", "Denmark");
premiere1.Add("Cinema", "Cineplexx");
premiere1.Add("PremiereDate", "21.11.2018");
premiere1.Add("emp_trigger", 1);

Dictionary premiere2 = new Dictionary();
premiere2.Add("Country", "Macedonia");
premiere2.Add("Cinema", "Cineplexx");
premiere2.Add("PremiereDate", "01.11.2018");
premiere2.Add("emp_trigger", 1);

premieres.Add(premiere1);
premieres.Add(premiere2);

movie.Add("Title", "Bohemian Rhapsody");
movie.Add("ReleaseDate", "02.11.2018");
movie.Add("Actors", actors);
movie.Add("Oscar", false);
movie.Add("Rating", 8.4);
movie.Add("Premiere", premieres);
movie.Add("emp_trigger", 1);

movies.Add("Movie",movie);
movies.Add("emp_trigger", 1);
movies.Add("fieldid",13);

otmValues.Add(movies);

object result = parser.AddSubscriberToList(subscriber, null, otmValues);

GetSubscribers

Get a List of Subscriber information based on search criteria.

Parametres:

• <Dictionary>  searchinfo – Search details:
• <String> List – Set List id(s) from which you want to retrieve Subscribers.
• <String> Status – active / unsubscribed / unconfirmed / disabled / all. [Defalut is active]
• <String> type – after / before / exact / between.
• <String> StartDate – Starting date.
• <String> EndDate – Ending date.
• <Boolean>  countOnly – Whether to do a count only, or get the List of Subscribers as well.
• <Integer>  limit – Number of records you want to fetch. [Defalut and maximum is 1000]
• <Integer>  offset – From where to start.

GetSubscribers(searchinfo, countOnly, limit, offset);

$ http GET "https://api.mailmailmail.net/v1.1/Subscribers/GetSubscribers?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&searchinfo=value&countonly=value&limit=value&offset=value"

Returns:

On success:

<List<SubscriberObj>>  List of Subscribers with respective information.

If countOnly specified:

<Integer> Number of Subscribers.

On failure:

<Boolean> false

Examples:

$ http GET "https://api.mailmailmail.net/v1.1/Subscribers/GetSubscribers?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&searchinfo[List]=any&searchinfo[Status]=unconfirmed"

All subscribers:

Dictionary<string string> searchinfo = new Dictionary<string, string>();
searchinfo.Add("Status", "all");
object result = parser.GetSubscribers(searchinfo);

All active subscribers:

object result = parser.GetSubscribers();

All unconfirmed subscribers in lists:

Dictionary<string string> searchinfo = new Dictionary<string, string>();
searchinfo.Add("List", "any");
searchinfo.Add("Status", "unconfirmed");

object result = parser.GetSubscribers(searchinfo);

Count unsubscribed subscribers in list:

Dictionary<string string> searchinfo = new Dictionary<string, string>();
searchinfo.Add("List", "19");
searchinfo.Add("Status", "unsubscribed");
bool countOnly = true;

object result = parser.GetSubscribers(searchinfo, countOnly);

Subscribers in specific list(s):

Dictionary<string string> searchinfo = new Dictionary<string, string>();
searchinfo.Add("List", "12");

object result = parser.GetSubscribers(searchinfo);

Subscribers added today:

Dictionary<string string> searchinfo = new Dictionary<string, string>();
searchinfo.Add("type", "after");
searchinfo.Add("StartDate", "today");

object result = parser.GetSubscribers(searchinfo);

Subscribers added in last 24 hours:

Dictionary<string, string> searchinfo = new Dictionary<string, string>();
searchinfo.Add("type", "after");
searchinfo.Add("StartDate", "-24 hours");

object result = parser.GetSubscribers(searchinfo);

Subscribers added in last week [in last 7 days, not from Monday]:

Dictionary searchinfo = new Dictionary();
searchinfo.Add("type", "after");
searchinfo.Add("StartDate", "tomorrow -1 week");
	
object result = parser.GetSubscribers(searchinfo);

Subscribers added before specific date:

Dictionary<string, string> searchinfo = new Dictionary<string, string>();
searchinfo.Add("type", "before");
searchinfo.Add("StartDate", "17-05-2016");

object result = parser.GetSubscribers(searchinfo);

Subscribers added on specific date:

Dictionary<string, string> searchinfo = new Dictionary<string, string>();
searchinfo.Add("type", "exactly");
searchinfo.Add("StartDate", "19 May 2017");

object result = parser.GetSubscribers(searchinfo);

Subscribers added between 2 dates:

Dictionary<string, string> searchinfo = new Dictionary<string, string>();
searchinfo.Add("type", "between");
searchinfo.Add("StartDate", "10 May 2017");
searchinfo.Add("EndDate", "20-May-2017");

object result = parser.GetSubscribers(searchinfo);

Subscribers in specific list(s) added today:

Dictionary<string, string> searchinfo = new Dictionary<string, string>();
searchinfo.Add("List", "12");
searchinfo.Add("type", "after");
searchinfo.Add("StartDate", "today");

object result = parser.GetSubscribers(searchinfo);

GetSubscribersByCustomField

Get a List of Subscriber information based on custom field.

Parametres:

• <Integer> listid – ID of the list. [Required]
• <Array> data – Data for custom fields. [Required]
• <Boolean> activeОnly – Whether or not to check for active Subscribers only..
• <Boolean> countOnly – Whether to do a count only, or get the List of Subscribers as well.
• <Integer> limit – Number of records you want to fetch. [Defalut and maximum is 1000]
• <Integer> offset – From where to start.

GetSubscribersByCustomField(listid, data, activeОnly, countOnly, limit, offset);

$ http GET "https://api.mailmailmail.net/v1.1/Subscribers/GetSubscribersByCustomField?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&listid=value&data=value&activeonly&countonly=value&limit=value&offset=value"

Returns:

On success:

<Array>  array(List of Subscribers with respective information)

If countOnly specified:

<Integer> Number of Subscribers

On failure:

<Array> array(false, message)

Examples:

$ http GET "https://api.mailmailmail.net/v1.1/Subscribers/GetSubscribersByCustomField?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&listid=55&data[0][fieldid]=150&data[0][fieldvalue]=Name&data[0][operator]=OR&data[1][fieldid]=151&data[1][fieldvalue]=Last Name"

List<ContactFieldText> data = new List<ContactFieldText>();

int listid = 55;

ContactFieldText cont1 = new ContactFieldText();
cont1.fieldid = 150;
string[] value1 = new string[] { "Name" };
cont1.fieldvalue = value1;
cont1.rule = "OR";
data.Add(cont1);

ContactFieldText cont2 = new ContactFieldText();
cont2.fieldid = 151;
string[] value1 = new string[] { "Last Name" };
cont2.fieldvalue = value1;
data.Add(cont2);
        
object result = parser.GetSubscribersByCustomField(listid, data);

List<ContactFieldText> data = new List<ContactFieldText>();

int listid = 55;

ContactFieldText cont1 = new ContactFieldText();
cont1.fieldid = 150;
string[] value1 = new string[] { "05-07-2018" };
cont1.fieldvalue = value1;
cont1.rule = "AND";
cont1.searchType = "after";
data.Add(cont1);

ContactFieldText cont2 = new ContactFieldText();
cont2.fieldid = 150;
string[] value1 = new string[] { "05-12-2018" };
cont2.fieldvalue = value1;
cont2.searchType = "before";
data.Add(cont2);
        
object result = parser.GetSubscribersByCustomField(listid, data);

List<ContactFieldText> data = new List<ContactFieldText>();

int listid = 55;

ContactFieldText cont1 = new ContactFieldText();
cont1.fieldid = 152;
string[] value1 = new string[] { "Blue" };
cont1.fieldvalue = value1;
cont1.rule = "OR";
data.Add(cont1);

ContactFieldText cont2 = new ContactFieldText();
cont2.fieldid = 153;
string[] value1 = new string[] { "155" };
cont2.fieldvalue = value1;
data.Add(cont2);

int limit = 100;
bool activeОnly = true;
bool countOnly = false;
        
object result = parser.GetSubscribersByCustomField(listid, data, activeОnly, countOnly, limit);

List<ContactFieldText> data = new List<ContactFieldText>();

int listid = 55;

ContactFieldText cont1 = new ContactFieldText();
cont1.fieldid = 150;
string[] value1 = new string[] { "05-07-2018" };
cont1.fieldvalue = value1;
string[] value2 = new string[] { "20-08-2018" };
cont1.fieldvalue_end-date = value2;
cont1.searchType = "between";
data.Add(cont1);
        
object result = parser.GetSubscribersByCustomField(listid, data);

LoadSubscriberCustomFields

Loads customfield data based on the list specified.

Parametres:

• <Integer> subscriberid – ID of the subscriber. [Required]
• <Integer> listid – ID of the list. [Required]

LoadSubscriberCustomFields(subscriberid, listid);

$ http GET "https://api.mailmailmail.net/v1.1/Subscribers/LoadSubscriberCustomFields?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&subscriberid=value&listid=value"

Returns:

On success:

<Array>  Subscriber's custom field data for that particular list

On failure:

<String> message

Examples:

$ http GET "https://api.mailmailmail.net/v1.1/Subscribers/LoadSubscriberCustomFields?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&subscriberid=150&listid=55"

int subscriberid = 150;
int listid = 55;

object result = parser.LoadSubscriberCustomFields(subscriberid, listid);

GetOneToManySubscriberData

Loads OTM data for subscriber.

Parametres:

• <Integer> subscriberid – ID of the subscriber. [Required]
• <Integer> fieldid – ID of the field. [Required]

GetOneToManySubscriberData(subscriberid, fieldid);

$ http GET "https://api.mailmailmail.net/v1.1/CustomFields/GetOneToManySubscriberData?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&subscriberID=value&fieldID=value"

Returns:

On success:

<Array>  Subscriber's OTM data

On failure:

<Array> array(false, message)

Examples:

$ http GET "https://api.mailmailmail.net/v1.1/CustomFields/GetOneToManySubscriberData?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&subscriberID=150&fieldID=55"

int subscriberid = 150;
int fieldid = 55;

object result = parser.GetOneToManySubscriberData(subscriberid, fieldid);

GetSubscriberDetails

Gets subscriber data including last events events and bounces.

Parametres:

• <Integer> listid – Contact List to be searched. [Required]
• <Integer> subscriberid – ID of the Subscriber about which you require more details. [Required if email and mobile are not specified]
• <String>  emailaddress – Email address of the Subscriber about which you require more details. [Required if subscriberid and mobile are not specified]
• <String>  mobile – Mobile number of the Subscriber about which you require more details. [Required if subscriberid and emial are not specified]
• <String>  mobilePrefix – Country dialing code.

GetSubscriberDetails(listid, subscriberid, emailaddress, mobile, mobilePrefix);

$ http GET "https://api.mailmailmail.net/v1.1/Subscribers/GetSubscriberDetails?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&listid=value&subscriberid=value&emailaddress=value&mobile=value&mobile_prefix=value"

Returns:

On success:

<SubscriberObj> Subscriber details.

On failure:

<String> message

Examples:

$ http GET "https://api.mailmailmail.net/v1.1/Subscribers/GetSubscriberDetails?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&listid=12&subscriberid=0&emailaddress=test@asp.net"

string emailaddress = "test@asp.net";
int listid = 12;

object result = parser.GetSubscriberDetails(listid, 0, emailaddress);

string mobile = "72589985"
string mobilePrefix = "389";
int listid = 12;

object result = parser.GetSubscriberDetails(listid, 0, "", mobile, mobilePrefix);

int listid = 12;
int subscriberid = 62;

object result = parser.GetSubscriberDetails(listid, subscriberid);

GetSubscriberEvents

Gets subscriber events.

Parametres:

• <Integer> listid – Contact List to be searched. [Required]
• <Integer> subscriberid – ID of the Subscriber about which you require more details. [Required]
• <Integer> limit – Number of records you want to fetch. . [Defalut is 100, maximum is 1000]
• <Integer> offset – From where to start.

GetSubscriberEvents(listid, subscriberid, limit, offset);

$ http GET "https://api.mailmailmail.net/v1.1/Subscribers/GetSubscriberEvents?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&listid=value&subscriberid=value&limit=value&offset=value"

Returns:

On success:

<EventObj> Subscriber events.

On failure:

<Array> {"false", message}

Examples:

$ http GET "https://api.mailmailmail.net/v1.1/Subscribers/GetSubscriberEvents?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&listid=12&subscriberid=62"

int listid = 12;
int subscriberid = 62;

object result = parser.GetSubscriberEvents(listid, subscriberid);

int listid = 12;
int subscriberid = 62;
int limit = 50;
int offset = 5;

object result = parser.GetSubscriberEvents(listid, subscriberid, limit, offset);

GetSubscribersUpdatedSince

Get a List of Subscribers updated after the specified date.

Parametres:

• <String> date – Set the date. [Required]
• <Array> listids – Set List id(s) from which you want to retrieve Subscribers.
• <Integer> limit – Number of records you want to fetch. [Defalut and maximum is 1000]
• <Integer> offset – From where to start.

GetSubscribersUpdatedSince(date, listids, limit, offset);

$ http GET "https://api.mailmailmail.net/v1.1/Subscribers/GetSubscribersUpdatedSince?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&date=value&listid=value&limit=value&offset=value"

Returns:

On success:

<Array> array(List of Subscribers with respective information)

On failure:

<Array> Empty array.

Examples:

$ http GET "https://api.mailmailmail.net/v1.1/Subscribers/GetSubscribersUpdatedSince?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&date=23.01.2018&listid=19&limit=10&offset=0"

string date = "23.01.2018";
int[] listids = new int[] {1, 2, 3};
int limit = 10;
int offset = 0;

object result = parser.GetSubscribersUpdatedSince(date, listids, limit, offset);

GetSubscribersFromSegment

Get a list of subscribers from segment.

Parametres:

• <Integer> segmentid – ID of the segment. [Required]
• <Boolean>  countOnly – Whether to do a count only, or get the List of Subscribers as well.
• <Boolean>  activeOnly – Whether or not to check for active Subscribers only..
• <Integer>  limit – Number of records you want to fetch. [Default is 100 and maximum is 1000]
• <Integer>  offset – From where to start.

GetSubscribersFromSegment(segmentid, countOnly, activeOnly, limit, offset);

$ http GET "https://api.mailmailmail.net/v1.1/Subscribers/GetSubscribersFromSegment?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&segmentid=value&countonly=value&activeonly=value&limit=value&offset=value"

Returns:

On success:

<Array> array(List of Subscribers with respective information)

On failure:

<Boolean> false

Examples:

$ http GET "https://api.mailmailmail.net/v1.1/Subscribers/GetSubscribersFromSegment?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&segmentid=56"

int segmentid = 56;

object result = parser.GetSubscribersFromSegment(segmentid);

int segmentid = 56;
bool countOnly = true;

object result = parser.GetSubscribersFromSegment(segmentid,countOnly);

int segmentid = 56;
bool countOnly = false;
bool activeOnly = true;
int limit = 20;

object result = parser.GetSubscribersFromSegment(segmentid,countOnly,activeOnly,limit);

GetTriggers

Get a list of triggers for list or all triggers.

Parametres:

• <Integer>  listid – ID of the list for trigger.
• <Integer>  limit – Number of records you want to fetch. [Default and maximum is 1000]
• <Integer>  offset – From where to start.

GetTriggers(listid, limit, offset);

$ http GET "https://api.mailmailmail.net/v1.1/Triggers/GetTriggers?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&listid=value&limit=value&offset=value"

Returns:

On success:

<Array> array(List of triggers with respective information)

On failure:

<Boolean> false

Examples:

$ http GET "https://api.mailmailmail.net/v1.1/Triggers/GetTriggers?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&listid=56"

int listid = 56;

object result = parser.GetTriggers(listid);

int listid = 56;
int limit = 10;

object result = parser.GetTriggers(listid,limit);

GetTriggersForSegment

Get a list of triggers for segment.

Parametres:

• <Integer> segmentid – ID of the segment. [Required]

GetTriggersForSegment(segmentid);

$ http GET "https://api.mailmailmail.net/v1.1/Segments/GetTriggersForSegment?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&segmentid=value"

Returns:

On success:

<Array> array(List of triggers with respective information)

On failure:

<Array> Empty array.

Examples:

$ http GET "https://api.mailmailmail.net/v1.1/Segments/GetTriggersForSegment?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&segmentid=56"

int segmentid = 56;

object result = parser.GetTriggersForSegment(segmentid);

CreateSegment

Create segment with specific rules.

Parametres:

• <String>  name – Name of segment.
• <Array>  rules – Rules for segment.
• <String>  connector – Matching all rules or any rules, and/or.

CreateSegment(name, rules, connector);

$ http GET "https://api.mailmailmail.net/v1.1/Segments/CreateSegment?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&name=value&rules=value&connector=value"

Returns:

On success:

<Integer> new segment id

On failure:

<Boolean> false

Examples:

$ http GET "https://api.mailmailmail.net/v1.1/Segments/CreateSegment?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&name=segment"

Basic fields                        
            
emailaddress        
mobilePhone
format
confirmationStatus
activityStatus
smsStatus
mailRating
dateAdded
clickedOnLink
emailCampaign
subscriberSource

Custom fields

Rule name is id of custom field

Rules                      
            
'=' => is / equal
'=' => is on
'=' => has clicked
'!=' => is not / not equal
'!=' => has not clicked
'!=' => is not on
'contains' => contains
'notContain' => does not contain
'empty' => is empty 
'notEmpty' => is not empty
'after' => is after
'before' => is before
'between' => is between
'opened' => has opened
'notOpened' => has not opened
'sent' => sent
'notSent' => not sent 

Values                        
            
'html' => HTML                                              'manual' => Manual
'text' => Text                                              'api' => Api
'confirmed' => Confirmed                                    'facebook' => Facebook 
'unconfirmed' => Unconfirmed                                'connector' => Connector
'active' => Active                                          'unknown' => Unknown
'bounced' => Bounced   
'unsubscribed' => Unsubscribed
'disabled' => Disabled
'any' => Any Link
'any' => Any Email Campaign
'lastMonth' => Any Campaign Last Month
'last3Months' => Any Campaign Last 3 Months
'last6Months' => Any Campaign Last 6 Months
'last9Months' => Any Campaign Last 9 Months
'last12Months' => Any Campaign Last 12 Months
'webForm' => Web Form 
'import' => Import

string name = "test segment";
string connector = "and";

Dictionary<string, object> allSegments = new Dictionary<string, object>();

Dictionary<string, object>[] segments = new Dictionary<string, object>[1];
Dictionary<string, object> segment = new Dictionary<string, object>();

Dictionary<string, object>[] rules = new Dictionary<string, object>[1];
Dictionary<string, object> rule = new Dictionary<string, object>();

rule.Add("ruleName", "emailaddress");
rule.Add("ruleOperator", "=");
rule.Add("ruleValue", "test@dev.com");

rules[0] = rule;

segment.Add("listids", new int[] { 189 });
segment.Add("rules", rules);

segments[0] = segment;

allSegments.Add("Segments", segments);

object result = parser.CreateSegment(name, allSegments, connector);

string name = "test segment";
string connector = "and";

Dictionary<string, object> allSegments = new Dictionary<string, object>();

Dictionary<string, object>[] segments = new Dictionary<string, object>[1];
Dictionary<string, object> segment = new Dictionary<string, object>();

Dictionary<string, object>[] rules = new Dictionary<string, object>[2];
Dictionary<string, object> ruleOne = new Dictionary<string, object>();
Dictionary<string, object> ruleTwo = new Dictionary<string, object>();

ruleOne.Add("ruleName", "emailaddress");
ruleOne.Add("ruleOperator", "=");
ruleOne.Add("ruleValue", "test@dev.com");

ruleTwo.Add("ruleName", "mobilePhone");
ruleTwo.Add("ruleOperator", "=");
ruleTwo.Add("ruleValue", "078123123");

rules[0] = ruleOne;
rules[1] = ruleTwo;

segment.Add("listids", new int[] { 189 });
segment.Add("rules", rules);

segments[0] = segment;

allSegments.Add("Segments", segments);

object result = parser.CreateSegment(name, allSegments, connector);

string name = "test segment";
string connector = "and";

Dictionary<string, object> allSegments = new Dictionary<string, object>();

Dictionary<string, object>[] segments = new Dictionary<string, object>[1];
Dictionary<string, object> segment = new Dictionary<string, object>();

Dictionary<string, object>[] rules = new Dictionary<string, object>[1];
Dictionary<string, object> rule = new Dictionary<string, object>();

rule.Add("ruleName", "dateAdded");
rule.Add("ruleOperator", "between");
rule.Add("ruleValue", new string[] {'20/01/2018','20/02/2019'});

rules[0] = rule;

segment.Add("listids", new int[] { 189 });
segment.Add("rules", rules);

segments[0] = segment;

allSegments.Add("Segments", segments);

object result = parser.CreateSegment(name, allSegments, connector);

string name = "test segment";
string connector = "and";

Dictionary<string, object> allSegments = new Dictionary<string, object>();

Dictionary<string, object>[] segments = new Dictionary<string, object>[2];
Dictionary<string, object> segmentOne = new Dictionary<string, object>();
Dictionary<string, object> segmentTwo = new Dictionary<string, object>();

Dictionary<string, object>[] rulesOne = new Dictionary<string, object>[1];
Dictionary<string, object> ruleOne = new Dictionary<string, object>();

Dictionary<string, object>[] rulesTwo = new Dictionary<string, object>[1];
Dictionary<string, object> ruleTwo = new Dictionary<string, object>();

ruleOne.Add("ruleName", "emailaddress");
ruleOne.Add("ruleOperator", "=");
ruleOne.Add("ruleValue", "test@dev.com");

ruleTwo.Add("ruleName", "mobilePhone");
ruleTwo.Add("ruleOperator", "=");
ruleTwo.Add("ruleValue", "078123123");

rulesOne[0] = ruleOne;
rulesTwo[0] = ruleTwo;

segmentOne.Add("listids", new int[] { 189 });
segmentOne.Add("rules", rulesOne);

segmentTwo.Add("listids", new int[] { 220 });
segmentTwo.Add("rules", rulesTwo);

segments[0] = segmentOne;
segments[1] = segmentTwo;

allSegments.Add("Segments", segments);

object result = parser.CreateSegment(name, allSegments, connector);

GetSegments

Get a list of segments for list or all segments.

Parametres:

• <Integer>  listid – ID of the list for segment.
• <Integer>  countSubscribers – Count active subscribers.
• <Integer>  limit – Number of records you want to fetch. [Default and maximum is 100]
• <Integer>  offset – From where to start.

GetSegments(listid, countSubscribers, limit, offset);

$ http GET "https://api.mailmailmail.net/v1.1/Segments/GetSegments?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&listid=value&count_subscribers=value&limit=value&offset=value"

Returns:

On success:

<Array> array(List of segments with respective information)

On failure:

<Boolean> false

Examples:

$ http GET "https://api.mailmailmail.net/v1.1/Segments/GetSegments?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&listid=56"

int listid = 56;

object result = parser.GetSegments(listid);

int listid = 56;
bool countSubscribers = true;
int limit = 10;

object result = parser.GetSegments(listid, countSubscribers, limit);

GetSegmentSummary

Calculates the total number of Emails sent, Bounces, Unsubscribes, Opens, Forwards and Link Clicks for Segment

Parametres:

• <Integer> segmentid – ID of the segment. [Required]
• <String> from – Start Date for filtering
• <String> to – End Date for filtering

GetSegmentSummary(segmentid, from, to);

$ http GET "https://api.mailmailmail.net/v1.1/Segments/GetSegmentSummary?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&segmentid=value&from=value&to=value"

Returns:

On success:

<StatsObj> Details about the Statistics entry.

On failure:

<Boolean> false

Examples:

$ http GET "https://api.mailmailmail.net/v1.1/Segments/GetSegmentSummary?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&segmentid=56"

int segmentid = 56;

object result = parser.GetSegmentSummary(segmentid);

int segmentid = 56;
string from = "30-04-2018";

object result = parser.GetSegmentSummary(segmentid,from);

int segmentid = 56;
string to = "30-09-2018";

object result = parser.GetSegmentSummary(segmentid,"",to);

GetRulesForSegment

Get all rules for Segment

Parametres:

• <Integer> segmentid – ID of the segment. [Required]

GetRulesForSegment(segmentid);

$ http GET "https://api.mailmailmail.net/v1.1/Segments/GetRulesForSegment?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&segmentid=value"

Returns:

On success:

<List<RuleObj>> rules for segment

On failure:

<Boolean> false

Examples:

$ http GET "https://api.mailmailmail.net/v1.1/Segments/GetRulesForSegment?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&segmentid=value"

int segmentid = 56;

object result = parser.GetRulesForSegment(segmentid);

UpdateSubscriber

Updates Subscriber information.

Parametres:

• <Integer> listid – List from which the Subscriber will be updated. [Required]
• <Integer> subscriberid – Subscriberid to update. [Required if listid and email.mobile not specified]
• <String> emailaddress – Email address of the Subscriber you want update. [Required if subscriberid not specified]
• <String> mobile – Mobile of the Subscriber you want update. [Required if subscriberid or email not specified]
• <String> mobilePrefix – Country dialing code.
• <List<ContactFieldText>> contactFields – Contact Fields to be updated.
• <Dictionary>  otmValues – The values you want to add into OTM field.
• <String> Key
• <Object> Value

UpdateSubscriber(listid, subscriberid, emailaddress, mobile, mobilePrefix, contactFields);

$ http POST https://api.mailmailmail.net/v1.1/Subscribers/UpdateSubscriber --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&listid=value&subscriberid=value&emailaddress=value&mobile=value&mobilePrefix=value&customfields=value&otmValues=value"

Returns:

On success:

<Array> {true, "Subscriber has been updated"}

On failure:

<Array> {false, "Unable to query the database"}

Examples:

$ http POST https://api.mailmailmail.net/v1.1/Subscribers/UpdateSubscriber --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&listid=113&subscriberid=319&emailaddress=update@subscriber.net&mobile=70569358&mobilePrefix=389&customfields[0][fieldid]=11&customfields[0][value]=DNK&customfields[1][fieldid]=8&customfields[1][value]=Vejen&customfields[2][fieldid]=52&customfields[2][value][0]=Friday&customfields[2][value][1]=Sunday"

int listid = 113;
int subscriberid = 319;
string emailaddress = "update@subscriber.net";
string mobile = "70569358";
List<ContactFieldText> contactFields = new List<ContactFieldText>();

ContactFieldText city = new ContactFieldText();
city.fieldid = 8;
city.fieldvalue = "Vejen";
contactFields.Add(city);

ContactFieldText country = new ContactFieldText();
country.fieldid = 11;
country.fieldvalue = "DNK";
contactFields.Add(country);

weekdays.fieldid = 52;
string[] value2 = new string[] { "Friday", "Sunday" };
weekdays.fieldvalue = value2;
contactFields.Add(weekdays);

object result = parser.UpdateSubscriber(listid, subscriberid, emailaddress, mobile, contactFields);

Field structure:

int lisdid = 12;
int subscriberid = 105;

List<Dictionary<string, object>> otmValues = new List<Dictionary<string, object>>();
Dictionary<string, object> movie = new Dictionary<string, object>();
Dictionary<string, object>movies = new Dictionary<string, object>();
List<Dictionary<string, object>> actors = new List<Dictionary<string, object>>();
List<Dictionary<string, object>> premieres = new List<Dictionary<string, object>>();

Dictionary actor1 = new Dictionary();
actor1.Add("FirstName", "Rami");
actor1.Add("LastName", "malek");
actor1.Add("BirthDate", "12.05.1981");
actor1.Add("emp_trigger", 1);

Dictionary actor2 = new Dictionary();
actor2.Add("FirstName", "Lucy");
actor2.Add("LastName", "Boynton");
actor2.Add("BirthDate", "17.01.1994");
actor2.Add("emp_trigger", 1);

actors.Add(actor1);
actors.Add(actor2);

Dictionary premiere1 = new Dictionary();
premiere1.Add("Country", "Denmark");
premiere1.Add("Cinema", "Cineplexx");
premiere1.Add("PremiereDate", "21.11.2018");
premiere1.Add("emp_trigger", 1);

Dictionary premiere2 = new Dictionary();
premiere2.Add("Country", "Macedonia");
premiere2.Add("Cinema", "Cineplexx");
premiere2.Add("PremiereDate", "01.11.2018");
premiere2.Add("emp_trigger", 1);

premieres.Add(premiere1);
premieres.Add(premiere2);

movie.Add("Title", "Bohemian Rhapsody");
movie.Add("ReleaseDate", "02.11.2018");
movie.Add("Actors", actors);
movie.Add("Oscar", false);
movie.Add("Rating", 8.4);
movie.Add("Premiere", premieres);
movie.Add("emp_trigger", 1);

movies.Add("Movie",movie);
movies.Add("emp_trigger", 1);
movies.Add("fieldid",13);

otmValues.Add(movies);

object result = parser.UpdateSubscriber(listid, subscriberid, false, false, null, otmValues);

RequestUpdateEmail

Request to change current email address.

Parametres:

• <Integer> subscriberid – Subscriberid to update. [Required]
• <Integer> listid – List from which the Subscriber will be updated. [Required]
• <String> currentEmail – Current email address. [Required]
• <String> newEmail – New email address. [Required]
• <List<ContactFieldText>> contactFields – Contact Fields to be updated.

RequestUpdateEmail(subscriberid, listid, currentEmail, newEmail, contactFields);

$ http POST https://api.mailmailmail.net/v1.1/Subscribers/RequestUpdateEmail --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&subscriberid=value&listid=value&oldemail=value&newemail=value&contactFields=value"

Returns:

On success:

<Boolean> true

On failure:

<Boolean> false

Examples:

$ http POST https://api.mailmailmail.net/v1.1/Subscribers/RequestUpdateEmail --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&subscriberid=319&listid=113&oldemail=oldemail@requestupdate.net&newemail=newemail@requestupdate.net&contactFields[0][fieldid]=8&contactFields[0][value]=Skopje"

int subscriberid = 319;
int listid = 113;
string currentEmail = "currentemail@requestupdate.net";
string newEmail = "newemail@requestupdate.net";

List<ContactFieldText> contactFields = new List<ContactFieldText>();

ContactFieldText city = new ContactFieldText();
city.fieldid = 8;
city.fieldvalue = "Vejen";
contactFields.Add(city);

ContactFieldText country = new ContactFieldText();
country.fieldid = 11;
country.fieldvalue = "DNK";
contactFields.Add(country);

object result = parser.RequestUpdateEmail(subscriberid, listid, currentEmail, newEmail, contactFields);

ChangeMobile

Change subscriber mobile.

Parametres:

• <Integer> listid – List from which the Subscriber will be updated. [Required]
• <Integer> subscriberid – Subscriberid to update. [Required]
• <String> mobile – Mobile of the Subscriber you want update. [Required]
• <String> mobilePrefix – Country dialing code.

ChangeMobile(listid, subscriberid, mobile, mobilePrefix);

$ http POST https://api.mailmailmail.net/v1.1/Subscribers/ChangeMobile --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&listid=value&subscriberid=value&mobile=value&mobilePrefix=value"

Returns:

On success:

<Array> {true, "Mobile Number has been changed"}

On failure:

<Array> {false, "Unable to query the database"}

Examples:

$ http POST https://api.mailmailmail.net/v1.1/Subscribers/ChangeMobile --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&listid=113&subscriberid=319&mobile=70569358&mobilePrefix=389"

int listid = 113;
int subscriberid = 319;
string mobile = "70569358";

object result = parser.ChangeMobile(listid, subscriberid, mobile);

int listid = 113;
int subscriberid = 319;
string mobile = "70569358";
string mobilePrefix = "389";

object result = parser.ChangeMobile(listid, subscriberid, mobile, mobilePrefix);

SaveSubscriberCustomField

Saves contact field information for particular Subscriber, particular List and particular Field.

Parametres:

• <Integer>  subscriberid – ID of the Subscribers whose data requires updating. [Required]
• <ContactFieldText>  contactField – Custom Field you are saving. [Required]
• <Boolean>  skipEmptyData – Process will not be executed if the Field value is empty.
• <Dictionary>  otmValues – The values you want to add into OTM field.
• <String> Key
• <Object> Value

SaveSubscriberCustomField(subscriberid, contactField, skipEmptyData, otmValues);

$ http POST https://api.mailmailmail.net/v1.1/Subscribers/SaveSubscriberCustomField --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&subscriberid=value&fieldid=value&value=value&skipEmptyData=value&otmValues=value"

Returns:

On success:

<Boolean> true

On failure:

<Boolean> false

Examples:

$ http POST https://api.mailmailmail.net/v1.1/Subscribers/SaveSubscriberCustomField --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&subscriberid=1&fieldid=8&fieldValue=Bergen&skipEmptyData=true&otmValues=true"

int subscriberid = 12; 
ContactFieldText contactField = new ContactFieldText();
contactField.fieldid = 7;
contactField.fieldValue = new string[] { "5-11-2018" }; 
bool skipEmptyData = true; //Default is false

object result = parser.SaveSubscriberCustomField(subscriberid, contactField, skipEmptyData);

Example for checkbox:

int subscriberid = 12; 
ContactFieldText contactField = new ContactFieldText();
contactField.fieldid = 52;
contactField.fieldValue = new string[] { "Monday", "Tuesday", "Friday" }; 
bool skipEmptyData = true; //Default is false
object result = parser.SaveSubscriberCustomField(subscriberid, contactField, skipEmptyData);

Field structure:

int subscriberid = 12; 
bool skipEmptyData = true;

Dictionary<string, object> movie = new Dictionary<string, object>();
List<Dictionary<string, object>> actors = new List<Dictionary<string, object>>();
List<Dictionary<string, object>> premieres = new List<Dictionary<string, object>>();

Dictionary actor1 = new Dictionary();
actor1.Add("FirstName", "Rami");
actor1.Add("LastName", "malek");
actor1.Add("BirthDate", "12.05.1981");
actor1.Add("emp_trigger", 1);

Dictionary actor2 = new Dictionary();
actor2.Add("FirstName", "Lucy");
actor2.Add("LastName", "Boynton");
actor2.Add("BirthDate", "17.01.1994");
actor2.Add("emp_trigger", 1);

actors.Add(actor1);
actors.Add(actor2);

Dictionary premiere1 = new Dictionary();
premiere1.Add("Country", "Denmark");
premiere1.Add("Cinema", "Cineplexx");
premiere1.Add("PremiereDate", "21.11.2018");
premiere1.Add("emp_trigger", 1);

Dictionary premiere2 = new Dictionary();
premiere2.Add("Country", "Macedonia");
premiere2.Add("Cinema", "Cineplexx");
premiere2.Add("PremiereDate", "01.11.2018");
premiere2.Add("emp_trigger", 1);

premieres.Add(premiere1);
premieres.Add(premiere2);

movie.Add("Title", "Bohemian Rhapsody");
movie.Add("ReleaseDate", "02.11.2018");
movie.Add("Actors", actors);
movie.Add("Oscar", false);
movie.Add("Rating", 8.4);
movie.Add("Premiere", premieres);
movie.Add("emp_trigger", 1);

object result = parser.SaveSubscriberCustomField(subscriberid, null, skipEmptyData, movie);

AddToOTMDocument

Saves partial One-To-Many data for particular Subscriber

Parametres:

• <Integer> listid – List from which the Subscriber will be updated. [Required]
• <Integer>  subscriberid – ID of the Subscriber whose data requires updating. [Required if mobile or email not specified]
• <String> emailaddress – Email address of the Subscriber you want update. [Required if subscriberid or mobile not specified]
• <String> mobile – Mobile of the Subscriber you want update. [Required if subscriberid or email not specified]
• <String> mobilePrefix – Country dialing code.
• <Integer>  fieldid – The ID of Custom Field you are saving. [Required]
• <Dictionary>  values – The values you want to add into OTM field. [Required]
• <String> Key
• <Object> Value
• <String>  path – The path where you want to insert new data.

AddToOTMDocument(listid, subscriberid, emailaddress, mobile, mobilePrefix, fieldid, values, path);

$ http POST https://api.mailmailmail.net/v1.1/Subscribers/AddToOTMDocument --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&listid=value&subscriberid=value&emailaddress=value&mobile=value&mobilePrefix=value&fieldid=value&values=value&path=value"

Returns:

On success:

<Boolean> true

On failure:

<Array> array(false, "Message")

Examples:

$ http POST https://api.mailmailmail.net/v1.1/Subscribers/AddToOTMDocument --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&listid=1&subscriberid=1&emailaddress=false&mobile=false&mobilePrefix=false&fieldid=18&path=Bergen&values[FirstName]=FirstName&values[LastName]=LastName&values[BirthDate]=30.11.2018&"

Field structure:

Add new Actor into first movie.

int listid = 1;
int subscriberid = 1;
int fieldid = 18;
string path = "Movie[0].Actors";

Dictionary<string, object> actor = new Dictionary<string, object>();
actor.Add("FirstName", "First Name");
actor.Add("LastName", "Last Name");
actor.Add("BirthDate", "30.11.2018");
actor.Add("emp_trigger", 1);

object result = parser.AddToOTMDocument(listid, subscriberid, "", "", "", fieldid, actor, path);

Add new Premiere into second movie.

int listid = 1;
string emailaddress = "test@dev.com";
int fieldid = 18;
string path = "Movie[1].Premiere";

Dictionary<string, object> premiere = new Dictionary<string, object>();
premiere.Add("Country", "Denmark");
premiere.Add("Cinema", "Cineplexx");
premiere.Add("PremiereDate", "30.11.2018");
premiere.Add("emp_trigger", 1);

object result = parser.AddToOTMDocument(listid, 0, emailaddress, "", "", fieldid, premiere, path);

Add new Movie.

int listid = 1;
string mobile = "20121212";
string mobilePrefix = "45";
int fieldid = 18;
string path = "Movie";

Dictionary<string, object> movie = new Dictionary<string, object>();
List<Dictionary<string, object>> actors = new List<Dictionary<string, object>>();
List<Dictionary<string, object>> premieres = new List<Dictionary<string, object>>();

Dictionary actor1 = new Dictionary();
actor1.Add("FirstName", "Rami");
actor1.Add("LastName", "malek");
actor1.Add("BirthDate", "12.05.1981");
actor1.Add("emp_trigger", 1);

Dictionary actor2 = new Dictionary();
actor2.Add("FirstName", "Lucy");
actor2.Add("LastName", "Boynton");
actor2.Add("BirthDate", "17.01.1994");
actor2.Add("emp_trigger", 1);

actors.Add(actor1);
actors.Add(actor2);

Dictionary premiere1 = new Dictionary();
premiere1.Add("Country", "Denmark");
premiere1.Add("Cinema", "Cineplexx");
premiere1.Add("PremiereDate", "21.11.2018");
premiere1.Add("emp_trigger", 1);

Dictionary premiere2 = new Dictionary();
premiere2.Add("Country", "Macedonia");
premiere2.Add("Cinema", "Cineplexx");
premiere2.Add("PremiereDate", "01.11.2018");
premiere2.Add("emp_trigger", 1);

premieres.Add(premiere1);
premieres.Add(premiere2);

movie.Add("Title", "Bohemian Rhapsody");
movie.Add("ReleaseDate", "02.11.2018");
movie.Add("Actors", actors);
movie.Add("Oscar", false);
movie.Add("Rating", 8.4);
movie.Add("Premiere", premieres);
movie.Add("emp_trigger", 1);

object result = parser.AddToOTMDocument(listid, 0, "", mobile, mobilePrefix, fieldid, movie, path);

UpdateOTMDocument

Update One-To-Many data for specific Subscriber.

Parametres:

• <Integer> subscriberid – Subscriber ID whose data requires updating. [Required if emailaddress or mobile not specified]
• <Integer> listid – List from which the Subscriber will be updated. [Required if subscriberid not specified]
• <String> emailaddress – Subscriber email address whose data requires updating. [Required if subscriberid or mobile not specified]
• <String> mobile – Subscriber mobile whose data requires updating. [Required if subscriberid or emailaddress not specified]
• <String> mobilePrefix – Country dialing code. [Required if subscriberid or emailaddress not specified]
• <Integer> fieldid – Contact field ID you are saving. [Required]
• <Array> fieldValueOTM – The values you want to update on the OTM field. [Required]
• <String>  path – The path where you want to update data.

UpdateOTMDocument(subscriberid, listid, emailaddress, mobile, mobilePrefix, fieldid, fieldValueOTM, path);

$ http POST https://api.mailmailmail.net/v1.1/Subscribers/UpdateOTMDocument --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&subscriberid=value&fieldid=value&fieldValueOTM=value&path=value"

Returns:

On success:

<Array> array(true, "Message")

On failure:

<Array> array(false, "Message")

Examples:

$ http POST https://api.mailmailmail.net/v1.1/Subscribers/UpdateOTMDocument --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&subscriberid=1097&fieldid=17&path=Movie[1]&values[FirstName]=Ian&values[LastName]=McShane&values[BirthDate]=29.09.1942"

Field structure:

Update Oscar, ReleaseDate and Rating on Movies with Rating 6:

using eMailPlatform;

string username = 'API_USERNAME';
string token = 'API_TOKEN';
string format = 'json';

ApiParser parser = new ApiParser(username, token, format);

int subscriberID = 123555;
int listID = 5511;
string subscriberEmail = "test@mail.com";
string mobile = "078555555";
string mobilePrefix = "389";
int fieldID = 341;

string path= "Movie[Rating=6]";

Dictionary<string,object> values = new Dictionary<string,object>(); 

values.add("Oscar","true");
values.add("ReleaseDate","29-01-1942");
values.add("Rating","10");

string result = parser.UpdateOTMDocument(subscriberID, listID, subscriberEmail, mobile, mobilePrefix, fieldID, values, path);

Update Country, Cinema, PremiereDate on Premiere where Country is Spain on Movie with Title How High:

using eMailPlatform;

string username = 'API_USERNAME';
string token = 'API_TOKEN';
string format = 'json';

ApiParser parser = new ApiParser(username, token, format);

int subscriberID = 123555;
int listID = 5511;
string subscriberEmail = "test@mail.com";
string mobile = "078555555";
string mobilePrefix = "389";
int fieldID = 341;

string path= "Movie[Title=How High].Premiere[Country=Spain]";

Dictionary<string,object> values = new Dictionary<string,object>(); 

values.add("Country","Gana");
values.add("Cinema","NokoMoko");
values.add("PremiereDate","10-03-1992");

string result = parser.UpdateOTMDocument(subscriberID, listID, subscriberEmail, mobile, mobilePrefix, fieldID, values, path);

RemoveOTMDocument

Remove One-To-Many data for specific Subscriber.

Parametres:

• <Integer> subscriberid – Subscriber ID whose data have to be deleted. [Required]
• <Integer> fieldid – Contact Field ID that you want to delete. [Required]
• <String>  path – The path where you want to remove data.
• <Integer> index – Which element to delete.

RemoveOTMDocument(subscriberid, fieldid, path, index);

$ http POST https://api.mailmailmail.net/v1.1/Subscribers/RemoveOTMDocument --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&subscriberid=value&fieldid=value&path=value&index=value"

Returns:

On success:

<Array> array(true, "Message")

On failure:

<Array> array(false, "Message")

Examples:

$ http POST https://api.mailmailmail.net/v1.1/Subscribers/RemoveOTMDocument --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&subscriberid=1097&fieldid=17&path=Movie&index=2"

Field structure:

Remove 2nd Movie:

using eMailPlatform;

string username = 'API_USERNAME';
string token = 'API_TOKEN';
string format = 'json';

ApiParser parser = new ApiParser(username, token, format);

int subscriberid = 1097;
int fieldid = 17;
string path = "Movie";
index index = 1;

string result = parser.RemoveOTMDocument(subscriberid, fieldid, path, index);

Remove 2nd actor on 5th Movie:

int subscriberid = 1097;
int fieldid = 17;
string path = "Movie[4].Actor";
int index = 1;

string result = parser.RemoveOTMDocument(subscriberid, fieldid, path, index)

ResubscribeContact

Resubscribe subscriber if subscribed is deleted. Please note that using this method will result in sending out a confirmation email.

Parametres:

• <Integer>  listid – ID of the list. [Required]
• <String>  emailaddress – Email address of the subscriber. [Required if mobile not specified]
• <String>  mobile – Mobile of the subscriber. [Required if email not specified]
• <String>  mobilePrefix – Country dialing code.
• <Boolean>  addToAutoresponders – Whether or not to add the Subscriber to the List Autoresponders.
• <List<ContactFieldText>>  contactFields – Subscriber Contact Fields.
• <Dictionary>  otmValues – The values you want to add into OTM field.
• <String> Key
• <Object> Value

ResubscribeContact(listid, emailaddress, mobile, mobilePrefix, addToAutoresponders, contactFields, otmValues);

$ http POST https://api.mailmailmail.net/v1.1/Subscribers/ResubscribeContact --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&listid=value&emailaddress=value&mobileNumber=value&mobilePrefix=value&add_to_autoresponders=value&contactFields=value&otmValues=value"

Returns:

On success:

<Array> array(true, message)

On failure:

<Array> array(true, message)

Examples:

$ http POST https://api.mailmailmail.net/v1.1/Subscribers/ResubscribeContact --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&listid=23&emailaddress=test@dev.com"

int listid = 12; 
String emailaddress = "test@dev.com";

object result = parser.ResubscribeContact(listid, emailaddress);

int listid = 12; 
String mobile = "20123456";
String mobilePrefix = "45";

object result = parser.ResubscribeContact(listid, "", mobile, mobilePrefix);

Field structure:

int listid = 12; 
String mobile = "20123456";
String mobilePrefix = "45";

List<Dictionary<string, object>> otmValues = new List<Dictionary<string, object>>();
Dictionary<string, object> movie = new Dictionary<string, object>();
Dictionary<string, object>movies = new Dictionary<string, object>();
List<Dictionary<string, object>> actors = new List<Dictionary<string, object>>();
List<Dictionary<string, object>> premieres = new List<Dictionary<string, object>>();

Dictionary actor1 = new Dictionary();
actor1.Add("FirstName", "Rami");
actor1.Add("LastName", "malek");
actor1.Add("BirthDate", "12.05.1981");
actor1.Add("emp_trigger", 1);

Dictionary actor2 = new Dictionary();
actor2.Add("FirstName", "Lucy");
actor2.Add("LastName", "Boynton");
actor2.Add("BirthDate", "17.01.1994");
actor2.Add("emp_trigger", 1);

actors.Add(actor1);
actors.Add(actor2);

Dictionary premiere1 = new Dictionary();
premiere1.Add("Country", "Denmark");
premiere1.Add("Cinema", "Cineplexx");
premiere1.Add("PremiereDate", "21.11.2018");
premiere1.Add("emp_trigger", 1);

Dictionary premiere2 = new Dictionary();
premiere2.Add("Country", "Macedonia");
premiere2.Add("Cinema", "Cineplexx");
premiere2.Add("PremiereDate", "01.11.2018");
premiere2.Add("emp_trigger", 1);

premieres.Add(premiere1);
premieres.Add(premiere2);

movie.Add("Title", "Bohemian Rhapsody");
movie.Add("ReleaseDate", "02.11.2018");
movie.Add("Actors", actors);
movie.Add("Oscar", false);
movie.Add("Rating", 8.4);
movie.Add("Premiere", premieres);
movie.Add("emp_trigger", 1);

movies.Add("Movie",movie);
movies.Add("emp_trigger", 1);
movies.Add("fieldid",13);

otmValues.Add(movies);

object result = parser.ResubscribeContact(listid, "", mobile, mobilePrefix,false,null,otmValues);

int listid = 12; 
String mobile = "20123456";
String mobilePrefix = "45";

List<ContactFieldText> contactFields = new List<ContactFieldText>();

ContactFieldText title = new ContactFieldText();
title.fieldid = 1;
string[] valueTitle = new string[] { "Mr" };
title.fieldvalue = valueTitle;
contactFields.Add(title);

ContactFieldText city = new ContactFieldText();
city.fieldid = 8;
string[] valueCity = new string[] { "Kumanovo" };
city.fieldvalue = valueCity;
contactFields.Add(city);

object result = parser.ResubscribeContact(listid, "", mobile, mobilePrefix,false,contactFields);

IsSubscriberOnList

Checks whether a Subscriber is on a particular List based on their Email Address or subscriberid and whether you are checking only for active Subscribers.

Parametres:

• <Array> listids – ID of the List to check for. [Required]
• <String>  emailaddress – Email address to check for. [Required if mobile or subscriberid not specified]
• <String>  mobile – Mobile phone to check for. [Required if emailaddress or subscriberid not specified]
• <String>  mobilePrefix – Country dialing code.
• <Integer> subscriberid – Subscriber ID. This can be used instead of the email address. [Required if emailaddress or mobile not specified]
• <Boolean>  activeOnly – Whether or not to check for active Subscribers only.
• <Boolean>  notBounced – Whether or not to check for non-bounced Subscribers only.
• <Boolean>  returnListid – Whether to return the listid as well as the subscriberid.

IsSubscriberOnList(listsids, emailaddress, mobile, mobilePrefix, subscriberid, activeOnly, notBounced, returnListid);

$ http GET "https://api.mailmailmail.net/v1.1/Subscribers/IsSubscriberOnList?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&listids=value&emailaddress=value&mobile=value&mobilePrefix=value&subscriberid=value&activeonly=value¬_bounced=value&return_listid=value"

Returns:

On success:

<List<SubscriberObj>> Subscriber

On failure:

<Boolean> false

Examples:

$ http GET "https://api.mailmailmail.net/v1.1/Subscribers/IsSubscriberOnList?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&listids[0]=1&listids[1]=2&listids[2]=3&emailaddress=test@asp.net&mobile=72123456&mobilePrefix=389&subscriberid=22&activeonly=false¬_bounced=false&return_listid=false"

int[] listids = new int[] { 1, 2, 3 }; 
string emailaddress = "test@asp.net"; 
string mobile = "72123456" ;
string mobilePrefix = "389";
int subscriberid = 22;
bool activeOnly = false;
bool notBounced = false;
bool returnListid = false;

object result = parser.IsSubscriberOnList(listids, emailaddress, mobile, mobilePrefix, subscriberid, activeOnly, notBounced, returnListid);

IsUnSubscriber

Checks whether an email address is an 'unsubscriber'.

Parametres:

• <Integer> listid – Lists where the Subscriber is Subscribed. [Required]
• <String> emailaddress – Email Address to check. [Required if subscriberid not specified]
• <String> mobile – Mobile number to check. [Required if subscriberid not specified]
• <String> mobilePrefix – Country dialing code.
• <Integer> subscriberid – Subscriber ID to check. [Required if emailaddress and mobile not specified]
• <String> service – Check if Unsubscribed for Email or SMS. [Email is default]

IsUnsubscriber(listid, emailaddress, mobile, mobilePrefix, subscriberid, service)

$ http GET "https://api.mailmailmail.net/v1.1/Subscribers/IsUnSubscriber?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&listid=value&emailaddress=value&mobile=value&mobilePrefix=value&subscriberid=value&service=value"

Returns:

On success:

<Integer> Subscriber ID

On failure:

<Boolean> false

Examples:

$ http GET "https://api.mailmailmail.net/v1.1/Subscribers/IsUnSubscriber?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&listid=12&emailaddress=test@asp.net&mobile=&mobilePrefix=&subscriberid=22&service=email"

int listid = 12;   
string emailaddress = "test@asp.net";
string mobile = "";
string mobilePrefix;
int subscriberid = 22;
string service = "email"; // or "smscampaign"/"sms"; 

object result = parser.IsUnSubscriber(listid, emailaddress, mobile, mobilePrefix, subscriberid, service);

UnsubscribeSubscriberEmail

Unsubscribes an Email Address from a specific List.

Parametres:

• <Integer> listid – List from which to remove Subscriber. [Required]
• <String> emailaddress – Subscriber Email Address to be Unsubscribed. [Required if subscriberid not specified]
• <Integer> subscriberid – Subscriber ID to remove. [Required if emailaddress not specified]
• <Boolean> skipCheck – Whether to skip the check to make sure they are on the List.
• <Integer> statid – The statistics ID to be updated.

UnsubscribeSubscriberEmail(listid, emailaddress, subscriberid, skipCheck, statid);

$ http POST https://api.mailmailmail.net/v1.1/Subscribers/UnsubscribeSubscriberEmail --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&listid=value&emailaddress=value&subscriberid=value&skipcheck=value&statid=value"

Returns:

On success:

<Boolean> true

On failure:

<Boolean> false

Examples:

$ http POST https://api.mailmailmail.net/v1.1/Subscribers/UnsubscribeSubscriberEmail --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&listid=12&emailaddress=test@mail.net"

int listid = 12;
string emailaddress = "test@mail.net";

object result = parser.UnsubscribeSubscriberEmail(listid, emailaddress);

int subscriberid = 267;

object result = parser.UnsubscribeSubscriberEmail(listid, "", subscriberid);

string emailaddress = "test@mail.net";
int listid = 12;
bool skipCheck = false;
int statid = 32;

object result = parser.UnsubscribeSubscriberEmail(listid, emailaddress, 0, skipCheck, statid);

UnsubscribeSubsriberMobile

UUnsubscribes an Email Address from a specific List.

Parametres:

• <Integer> listid – List from which to remove the Subscriber. [Required]
• <String> mobile – Subscriber Email Address to be unsubscribed. [Required if subscriberid not specified]
• <String> mobilePrefix – Country dialing code. [Required if subscriberid not specified]
• <Integer> subscriberid – Subscriber ID to be removed. [Required if mobile and listid not specified]
• <Boolean> skipCheck – Whether to skip the check to make sure they are on the List.
• <Integer> statid – The statistics ID to be updated.

UnsubscribeSubscriberMobile(listid, mobile, mobilePrefix, subscriberid, skipCheck, statid);

$ http POST https://api.mailmailmail.net/v1.1/Subscribers/UnsubscribeSubscriberMobile --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&listid=value&mobile=value&mobilePrefix=value&subscriberid=value&skipcheck=value&statid=value"

Returns:

On success:

<Boolean> true

On failure:

<Boolean> false

Examples:

$ http POST https://api.mailmailmail.net/v1.1/Subscribers/UnsubscribeSubscriberMobile --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&listid=12&mobile=72445865&mobilePrefix=389&subscriberid=value"

int listid = 12;
string mobile = "72445865";
string mobilePrefix = "389";

object result = parser.UnsubscribeSubscriberMobile(listid, mobile, mobilePrefix);

int listid = 12;
int subscriberid = 267;

object result = parser.UnsubscribeSubscriberMobile(listid, "", "", subscriberid);

string mobile = "72445865";
string mobilePrefix = "389";
int listid = 12;
bool skipCheck = false;
int statid = 32;

object result = parser.UnsubscribeSubscriberMobile(listid, mobile, mobilePrefix, 0, skipCheck, statid);

GetAllListForEmailAddress

Gets all subscriberids, listids for a particular email address and returns an array of them.

Parametres:

• <String> emailaddress – The Email Address to be searched for on all Lists. [Required]
• <Array> listids – The Lists to checked for the Email Address. [Required]
• <Integer> mainListid – This is used for ordering the results of the query.
• <Boolean> activeOnly – Whether or not to check for active Subscribers only.
• <Boolean> includeDeleted – Whether or not to include Subscribers that are marked as deleted.

GetAllListsForEmailAddress(emailaddress, listids, mainListid, activeOnly, includeDeleted);

$ http GET "https://api.mailmailmail.net/v1.1/Subscribers/GetAllListsForEmailAddress?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&emailaddress=value&listids=value&main_listid=value&activeonly=value&include_deleted=value"

Returns:

On success:

<List<ListObj>> Objcets of ListObj.

On failure:

<Array> Empty.

Examples:

$ http GET "https://api.mailmailmail.net/v1.1/Subscribers/GetAllListsForEmailAddress?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&emailaddress=test@mail.net&listids[0]=1&listids[1]=2&listids[2]=3"

string emailaddress = "test@mail.net";
init[] listids = new int[] { 1, 2, 3 };

object result = parser.GetAllListsForEmailAddress(emailaddress,listids);

string emailaddress = "test@mail.net";
int[] listids = new int { 1, 2, 3 };
int mainListid = 2;
bool activeOnly = true;
bool deleted = false;

object result = parser.GetAllListsForEmailAddress(emailaddress, listids, mainListid, activeOnly, deleted);

DeleteSubscriber

All subscriber information is deleted and email/mobile is restricted from subscribing again - it will not be possible to add this contact again except from ResubscribeContact which the contact needs to confirm.

Parametres:

• <Integer> listid – List to from which to delete them. [Required]
• <String> emailaddress – Email Address to delete. [Required if subscriberid and mobile not specified]
• <String> mobile – Mobile number to delete.. [Required if subscriberid and emailaddress not specified]
• <String> mobilePrefix – Country dialing code.
• <Integer> subscriberid – Subscriberid to delete. [Required if subscriberid and emailaddress not specified]

DeleteSubscriber(listid, emailaddress, mobile, mobilePrefix, subscriberid);

$ http DELETE "https://api.mailmailmail.net/v1.1/Subscribers/DeleteSubscriber' -d 'Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&listid=value&emailaddress=value&mobile=value&mobilePrefix=value&subscriberid=value"

Returns:

On success:

<Boolean> true

On failure:

<Array> {false, message}

Examples:

$ http DELETE "https://api.mailmailmail.net/v1.1/Subscribers/DeleteSubscriber' -d 'Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&listid=12&emailaddress=test@asp.net&mobile=70123456&mobilePrefix=389&subscriberid=22"

int listid = 12;
string emailaddress = "test@asp.net";
string mobile = "70123456";
string mobilePrefix = "389";
int subscriberid = 22;

object result = parser.DeleteSubscriber(listid, emailaddress, mobile, mobilePrefix, subscriberid);

FetchStats

Fetches the details of a Newsletter or Autoresponder statistics entry.

Parametres:

• <Integer> statid – The statistics ID of the entry you want to retrieve from the database. [Required]
• <Char> statsType – The type of statistics of which the entry you are retrieving consists (i.e. n/a/t). [Required]

FetchStats(statid, statsType);

$ http GET "https://api.mailmailmail.net/v1.1/Stats/FetchStats?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&statid=value&statstype=value"

Returns:

On success:

 <StatsObj> Details about the Statistics entry.

On failure:

<Boolean> false

Examples:

$ http GET "https://api.mailmailmail.net/v1.1/Stats/FetchStats?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&statid=11&statstype=n"

int statid = 11;
char statsType = 'n';;

object result = parser.FetchStats(statid, statsType);

int statid = 25;
char statsType = 't';;

object result = parser.FetchStats(statid, statsType);

GetStatids

Get all statids.

Parametres:

• <Integer> listid – ID of list. [Required if segmentid and campaign id not specified]
• <Integer> segmentid – ID of segment. [Required if listid and campaign id not specified]
• <Integer> newsletterid – ID of newsletter. [Required if segmentid and listid id not specified]
• <String> from – Start Date for filtering
• <String> to – End Date for filtering
• <Integer> limit – Number of records you want to fetch. . [Defalut is 100, maximum is 100]
• <Integer> offset – From where to start.

GetStatids(listid, segmentid, newsletterid, from, to, limit, offset);

$ http GET "https://api.mailmailmail.net/v1.1/Stats/GetStatids?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&listid=value&segmentid=value&campaignid=value&from=value&to=value&limit=value&offset=value"

Returns:

On success:

 <StatsObj> Array of statids.

On failure:

<Boolean> false

Examples:

$ http GET "https://api.mailmailmail.net/v1.1/Stats/GetStatids?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&listid=11"

int listid = 11;

object result = parser.GetStatids(listid);

int listid = 11;
string from = "10-01-2019";

object result = parser.GetStatids(listid, 0, 0, from);

int listid = 11;
string from = "10-01-2019";
int newsletterid = 102;
int limit = 50;

object result = parser.GetStatids(listid, 0, newsletterid, from, "", limit);

GetListSummary

Calculates the total number of Emails sent, Bounces, Unsubscribes, Opens, Forwards and Link Clicks for a List.

Parametres:

• <Integer> listid – The stat id of the entry you want to retrieve from the database. [Required]
• <Integer> limit – Number of records you want to fetch for statids. [Default and maximum is 10]
• <Integer> offset – From where to start.

GetListSummary(listid, limit, offset);

$ http GET "https://api.mailmailmail.net/v1.1/Stats/GetListSummary?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&listid=value&limit=value&offset=value"

Returns:

On success:

 <StatsObj> Details about the Statistics entry.

On failure:

<Boolean> false

Examples:

$ http GET "https://api.mailmailmail.net/v1.1/Stats/GetListSummary?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&listid=11"

int listid = 11;

object result = parser.GetListSummary(listid);

int listid = 11;
int limit = 30;

object result = parser.GetListSummary(listid, limit);

int listid = 11;
int limit = 30;
int offset = 5;

object result = parser.GetListSummary(listid, limit, offset);

GetBouncesByList

Fetches a List of Bounced Emails.

Parametres:

• <Integer>  listid – ID of a List from which the results are fetched. [Required]
• <Boolean> countOnly – Whether to or not return just the number of Bounces instead of a List of Bounces.
• <String> bounceType – The type of Bounce for which to get results ("soft", "hard", "any").
• <String> searchType – Which search rule should be used in date search. Possible values: before, after, between, not, exact/exactly.
• <String> searchStartDate – Start Date for filtering.
• <String> searchEndDate – End Date for filtering.

GetBouncesByList(listid, countOnly, bounceType, searchType, searchStartDate, searchEndDate);

$ http GET "https://api.mailmailmail.net/v1.1/Stats/GetBouncesByList?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&listid=value&count_only=value&bounce_type=value&searchType=value&searchStartDate=value&searchEndDate=value"

Returns:

On success:

<List<StatsObj>> List of bounces

For count only:

<Integer> Number of bounces

On failure:

<Boolean> false

Examples:

$ http GET "https://api.mailmailmail.net/v1.1/Stats/GetBouncesByList?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&listid=11&count_only=false&bounce_type=any&searchType=between&searchStartDate=24-05-2017&searchEndDate=01.06.2017"

int listid = 11;
bool countOnly = false;
string bounceType = "any";
string searchType = "between";
string searchStartDate = "24-05-2017";
string searchEndDate = "01.06.2017";

object result = parser.GetBouncesByList(listid, countOnly, bounceType, searchType, searchStartDate, searchEndDate);

int listid = 11;
bool countOnly = true;

object result = parser.GetBouncesByList(listid, countOnly);

GetUnsubscribesByList

Fetches a List of Subscribers who Unsubscribed from a Campaign.

Parametres:

• <Integer> listid – ID of a List from which the results are fetched. [Required]
• <Boolean> countOnly – Whether or not to return only number of Unsubscribes instead of a full List.
• <String> searchType – Which search rule should be used in date search. Possible values: before, after, between, not, exact/exactly.
• <String> searchStartDate – Start Date for filtering.
• <String> searchEndDate – End Date for filtering.

GetunsubscribesByList(listid, countOnly, searchType, searchStartDate, searchEndDate);

$ http GET "https://api.mailmailmail.net/v1.1/Stats/GetUnsubscribesByList?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&listid=value&count_only=value&searchType=value&searchStartDate=value&searchEndDate=value"

Returns:

On success:

<List<StatsObj>> List of unsubscribed contacts

For count only:

<Integer> Number of unsubscribed contacts

On failure:

 <Boolean> false

Examples:

$ http GET "https://api.mailmailmail.net/v1.1/Stats/GetUnsubscribesByList?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&listid=11&count_only=true&searchType=between&searchStartDate=24-05-2017&searchEndDate=01.06.2017"

int listid = 12;
bool countOnly = true;
string searchType = "between";
string searchStartDate = "24-05-2017";
string searchEndDate = "01.06.2017";

object result = parser.GetUnsubscribesByList(listid, countOnly, searchType, searchStartDate, searchEndDate);

GetOpens

Return the openers of email campaign.

Parametres:

• <Integer> statid – The statistics ID for which you want to fetch data. [Required]
• <Boolean> countOnly – Whether or not to return the number of Openers instead of a List of Openers.
• <Boolean> uniqueOnly – Specify true for count/retrieve unique Opens only, specify false for all Opens.

GetOpens(statid, countOnly, uniqueOnly);

$ http GET "https://api.mailmailmail.net/v1.1/Stats/GetOpens?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&statid=value&count_only=value&only_unique=value"

Returns:

On success:

<List<StatsObj>> Returns List of StatsObj.

For count only:

<Integer> Total number of opens.

On failure:

<Array> Empty array.

Examples:

$ http GET "https://api.mailmailmail.net/v1.1/Stats/GetOpens?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&statid=11"

int statid = 11;

object result = parser.GetOpens(statid);

Counts the number of opens:

int statid = 11;
bool countOnly = true;email

object result = parser.GetOpens(statid, countOnly);

Counts the number of unique opens:

int statid = 11;
bool countOnly = true;
bool uniqueOnly = true;

object result = parser.GetOpens(statid, countOnly, uniqueOnly);

Details for unique opens:

int statid = 11;
int countOnly = false;
int uniqueOnly = true;

object result = parser.GetOpens(statid, countOnly, uniqueOnly);

GetRecipients

Return the Recipients of Autoresponder.

Parametres:

• <Integer> statid – The statistics ID for which you want to fetch data. [Required]
• <Boolean> countOnly – Whether to or not return only the number of Openers instead of a List of Openers.

GetRecipients(statid, countOnly);

$ http GET "https://api.mailmailmail.net/v1.1/Stats/GetRecipients?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&statid=value&count_only=value"

Returns:

On success:

<List<StatsObj>> List of Recipients.

For count only:

<Integer> Total number of Recipients.

On failure:

<Boolean> false

Examples:

$ http GET "https://api.mailmailmail.net/v1.1/Stats/GetRecipients?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&statid=11"

int statid = 11;

object result = parser.GetRecipients(statid);

Counts the number of Recipients:

int statid = 11;
bool countOnly = true;

object result =parser.GetRecipients(statid, countOnly);

GetLatestStats

Get latest newsletter statistics.

Parametres:

• <Integer> newsletterid – Newsletter ID for which you want to fetch data. [Required]
• <Integer> limit – Number of records you want to fetch. [Default is 1]

GetLatestStats(newsletterid, limit);

$ http GET "https://api.mailmailmail.net/v1.1/Stats/GetLatestStats?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&campaignid=value&limit=value"

Returns:

On success:

<Array> Newsletter statistic.

On failure:

<Boolean> false.

Examples:

$ http GET "https://api.mailmailmail.net/v1.1/Stats/GetLatestStats?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&campaignid=11"

int newsletterid = 11;

object result = parser.GetRecipients(newsletterid);

int newsletterid = 11;
int limit = 50;

object result = parser.GetRecipients(newsletterid, limit);

ScheduleSendNewsletter

Schedule newsletter campaign for sending.

Parametres:

• <Integer> campaignid – ID of the Campaign that is to be scheduled. [Required]
• <Float> timeToSend – When the campaign send should start (in how many hours from a starting point (real time : now)).
• <Boolean> saveSnapshots – Whether to save snapshot or not.
• <Boolean>  reloadFeed – Whether to reload feed before sending or not.
  • ● True by default
  • ● Using reloadFeed on every sending may result in slow sending
  • ● We are reloading the feed in smart intervals depending how frequently you get new products, so there is no need to reload before sending unless the item merged in the email is added to the product feed at the moment of sending
• <Boolean> notifyOwner – The owner will be notified when a newsletter has started and finished sending or when an issue occurs with the sending.
  • ●  False by default

ScheduleSendNewsletter(campaignid, timeToSend, saveSnapshots, reloadFeed, notifyOwner);

$ http POST https://api.mailmailmail.net/v1.1/Sends/ScheduleSend --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&campaignid=value&hours=value"

Returns:

On success:

<Array> {true, "Campaign has be scheduled"}

On failure:

<Array> {false, message}

Examples:

$ http POST https://api.mailmailmail.net/v1.1/Sends/ScheduleSend --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&campaignid=30&hours=1"

int campaignid = 30;
float timeToSend = 1; //Time in hours, 0.5f = 30 minutes
bool saveSnapshots = true;

object result = parser.ScheduleSendNewsletter(campaignid, timeToSend, saveSnapshots);

int campaignid = 30;
float timeToSend = 1; //Time in hours, 0.5f = 30 minutes
bool saveSnapshots = false;
bool reloadFeed = false;
bool notifyOwner = true;

object result = parser.ScheduleSendNewsletter(campaignid, timeToSend, saveSnapshots, reloadFeed, notifyOwner);

ScheduleSendNewsletterToLists

Schedule newsletter campaign for sending to specific lists.

Parametres:

• <Integer> campaignid – ID of the Campaign that is to be scheduled. [Required]
• <Float> timeToSend – When the campaign send should start (in how many hours from a starting point (real time : now)).
• <Array> listids – IDs of the lists.
• <Boolean> saveSnapshots – Whether to save snapshot or not.
• <Boolean>  reloadFeed – Whether to reload feed before sending or not.
  • ● True by default
  • ● Using reloadFeed on every sending may result in slow sending
  • ● We are reloading the feed in smart intervals depending how frequently you get new products, so there is no need to reload before sending unless the item merged in the email is added to the product feed at the moment of sending
• <Boolean> notifyOwner – The owner will be notified when a newsletter has started and finished sending or when an issue occurs with the sending.
  • ●  False by default

ScheduleSendNewsletterToLists(campaignid, timeToSend, listids, saveSnapshots, reloadFeed, notifyOwner);

$ http POST https://api.mailmailmail.net/v1.1/Sends/ScheduleSendNewsletterToLists --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&campaignid=value&hours=value&listids=value"

Returns:

On success:

<Array> array(true, "Campaign has be scheduled")

On failure:

<Array> array(false, message)

Examples:

$ http POST https://api.mailmailmail.net/v1.1/Sends/ScheduleSendNewsletterToLists --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&campaignid=30&hours=1&listids[0]=12"

int campaignid = 30;
float timeToSend = 1; //Time in hours, 0.5f = 30 minutes
int [] listids = new int[]{10,30};
bool saveSnapshots = true;

object result = parser.ScheduleSendNewsletterToLists(campaignid, timeToSend, listids, saveSnapshots);

int campaignid = 30;
float timeToSend = 1; //Time in hours, 0.5f = 30 minutes
int [] listids = new int[]{10,30};
bool saveSnapshots = false;
bool reloadFeed = false;
bool notifyOwner = true;

object result = parser.ScheduleSendNewsletterToLists(campaignid, timeToSend, listids, saveSnapshots, reloadFeed, notifyOwner;

ScheduleSendNewsletterToSegments

Schedule newsletter campaign for sending to specific segments.

Parametres:

• <Integer> campaignid – ID of the Campaign that is to be scheduled. [Required]
• <Float> timeToSend – When the campaign send should start (in how many hours from a starting point (real time : now)).
• <Array> segmentids – IDs of the segments.
• <Boolean> saveSnapshots – Whether to save snapshot or not.
• <Boolean>  reloadFeed – Whether to reload feed before sending or not.
  • ● True by default
  • ● Using reloadFeed on every sending may result in slow sending
  • ● We are reloading the feed in smart intervals depending how frequently you get new products, so there is no need to reload before sending unless the item merged in the email is added to the product feed at the moment of sending
• <Boolean> notifyOwner – The owner will be notified when a newsletter has started and finished sending or when an issue occurs with the sending.
  • ●  False by default

ScheduleSendNewsletterToSegments(campaignid, timeToSend, segmentids, saveSnapshots, reloadFeed, notifyOwner);

$ http POST https://api.mailmailmail.net/v1.1/Sends/ScheduleSendNewsletterToSegments--data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&campaignid=value&hours=value&listids=value"

Returns:

On success:

<Array> array(true, "Campaign has be scheduled")

On failure:

<Array> array(false, message)

Examples:

$ http POST https://api.mailmailmail.net/v1.1/Sends/ScheduleSendNewsletterToSegments --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&campaignid=30&hours=1&segmentids[0]=12"

int campaignid = 30;
float timeToSend = 1; //Time in hours, 0.5f = 30 minutes
int [] segmentids = new int[]{10,30};
bool saveSnapshots = true;

object result = parser.ScheduleSendNewsletterToSegments(campaignid, timeToSend, segmentids, saveSnapshots);

int campaignid = 30;
float timeToSend = 1; //Time in hours, 0.5f = 30 minutes
int [] segmentids = new int[]{10,30};
bool saveSnapshots = false;
bool reloadFeed = false;
bool notifyOwner = true;

object result = parser.ScheduleSendNewsletterToSegments(campaignid, timeToSend, segmentids, saveSnapshots, reloadFeed, notifyOwner);

ScheduleSendSMS

Schedule SMS campaign for sending.

Parametres:

• <Integer> campaignid – ID of the campain that is about to be scheduled. [Required]
• <Float> timeToSend – When the campaign send should start (in how many hours from a starting point (real time : now)).

ScheduleSendSMS(campaignid, timeToSend);

$ http POST https://api.mailmailmail.net/v1.1/SMSSends/ScheduleSend --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&campaignid=value&hours=value"

Returns:

On success:

<Array> {true, "Campaign has be scheduled"}

On failure:

 <Array> {false, message}

Examples:

$ http POST https://api.mailmailmail.net/v1.1/SMSSends/ScheduleSend --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&campaignid=30&hours=1"

int campaignid = 30;
float timeToSend = 1; //Time in hours, 0.5f = 30 minutes

object result = parser.ScheduleSendSMS(campaignid, timeToSend);

SendNewsletter

Attempts to send a newsletter to specific subscriber or seeks for subscriber with given email address.

Parametres:

• <Integer>  newsletterid – ID of the newsletter that will be sent. [Required]
• <Integer>  subscriberid – Recipient subscriber's ID. [Required if email not specified]
• <String>  emailaddress – Email used to found recipient from posible recipients of the newsletter. [Required if subscriberid not specified]
• <String>  senderEmail – Sender email from which the email will appear to be sent.
• <String>  senderName – Sender name from which the email will appear to be sent.
• <String>  replyEmail – Reply to email, replying will be use this email.
• <String>  callbackUrl – Callback url for tracking status of sending.
• <Boolean>  reloadFeed – Whether to reload feed before sending or not.
  • ● False by default
  • ● Using reloadFeed on every sending may result in slow sending
  • ● We are reloading the feed in smart intervals depending how frequently you get new products, so there is no need to reload before sending unless the item merged in the email is added to the product feed at the moment of sending
• <Boolean> notifyOwner – The owner will be notified when a newsletter has started and finished sending or when an issue occurs with the sending.
  • ●  False by default

SendNewsletter(newsletterid, subscriberid, emailaddress, senderEmail, senderName, replyEmail, callbackUrl, reloadFeed, notifyOwner);

$ http POST https://api.mailmailmail.net/v1.1/Messaging/SendNewsletter --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&newsletterid=value&subscriberid=value&email=value&fromaddress=value&fromname=value&replyaddress=value"

Returns:

On success:

<Array> (true, message)

On failure:

<Array> (false, message)

Examples:

$ http POST https://api.mailmailmail.net/v1.1/Messaging/SendNewsletter --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&newsletterid=56&subscriberid=21"

int newsletterid = 56;
int subscriberid = 21;

object responce = parser.SendNewsletter(newsletterid, subscriberid);

int newsletterid = 47;
string emailaddress = "test@mail.net";

object responce = parser.SendNewsletter(newsletterid, 0, emailaddress);

int newsletterid = 47;
string emailaddress = "test@mail.net";
bool reloadFeed = true;
bool notifyOwner = true;

object responce = parser.SendNewsletter(newsletterid, 0, emailaddress, "", "", "", "", reloadFeed, notifyOwner);

GetSnapshots

Get snapshot links for sent campaign, trigger and autoresponder

Parametres:

• <Integer>  subscriberid – Id for subscriber.[Required]
• <String>  triggerid – Id for trigger.
• <String>  autoresponderid – Id for autoresponder.
• <Integer>  newsletterid – Id for campaign.
• <Integer>  groupBy – Group by type/date. [Defalut is date]

GetSnapshots(subscriberid, triggerid, autoresponderid,newsletterid, groupBy)

$ http POST https://api.mailmailmail.net/v1.1/Stats/GetSnapshots --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&subscriberid=value&triggerid=value&autoresponderid=value&newsletterid=value&groupby=value"

Returns:

On success:

<SnapshotObj> List of snapshots

On failure:

<String> message

Examples:

$ http POST https://api.mailmailmail.net/v1.1/Stats/GetSnapshots --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&subscriberid=65"

int subscriberid = 65;

object responce = parser.GetSnapshots(subscriberid);

int subscriberid = 65;
int newsletterid = 120;

object responce = parser.GetSnapshots(subscriberid, 0, 0, newsletterid);

int subscriberid = 65;
int newsletterid = 120;
string groupBy = "type";

object responce = parser.GetSnapshots(subscriberid, 0, 0, newsletterid, groupBy);

GetNewsletters

Get a List of Newsletters based on the criteria passed in.

Parametres:

• <Boolean> countOnly – Whether or not to get a count of Lists only, rather than the information only.
• <Boolean> getLastSendDetails – Get information about the last sent details.
• <Boolean>  content – Whether to show Campaign content or not.
• <String> afterCreateDate – Get Newsletters created after this date.
• <String> newsletterNameLike – Get Newsletters with name like this.
• <Integer> limit – Number of records you want to fetch. [Defalut is 10 and maximum is 100]
• <Integer> offset – From where to start.

GetNewsletters(countOnly, getLastSendDetails, content, afterCreateDate, newsletterNameLike, limit, offset);

$ http GET "https://api.mailmailmail.net/v1.1/Newsletters/GetNewsletters?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&countOnly=value&getLastSentDetails=value&content=value&afterCreateDate=value&newsletterNameLike=value&limit=value&offset=value"

Returns:

On success:

 <List> List of Newsletters.

For CountOnly:

 <Integer> Number of Newsletters.

On failure:

<Boolean> false

Examples:

$ http GET "https://api.mailmailmail.net/v1.1/Newsletters/GetNewsletters?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&countOnly=false&getLastSentDetails=true&content=false&afterCreateDate=28-05-2017"

Get all newsletters:

object result = parser.GetNewsletters();

Count newsletters:

bool countOnly = false;

object = parser.GetNewsletters(countOnly);

Get newsletters created after 28 May 2017:

bool countOnly = false;
bool getLastSendDetails = true;
bool content = false;
string afterCreateDate = "28 May 2017"; // (28-05-2017; 28-May-2017)

object result = parser.GetNewsletters(countOnly, getLastSendDetails, content, afterCreateDate);

Count newsletters created after 28 May 2017:

bool countOnly = false;
bool getLastSendDetails = true;
bool content = false;
string afterCreateDate = "28 May 2017"; // (28-05-2017; 28-May-2017)

object result =parser.GetNewsletters(countOnly, getLastSendDetails, content, afterCreateDate);

Get newsletters with name "Newsletter 12":

string newsletterNameLike = "Newsletter 12";

object result = parser.GetNewsletters false, true, true, false,newsletterNameLike);

Get newsletters with limit and offset:

int limit = 20;
int offset = 5;

object result = parser.GetNewsletters false, true, true, false, false, limit, offset);

GetNewsletterSummary

Calculates the total number of Emails sent, Bounces, Unsubscribes, Opens and Link Clicks for Newsletter

Parametres:

• <Integer> newsletterid – ID of the newsletter. [Required]
• <Integer> statid – The statistics id.
• <String> from – Start Date for filtering
• <String> to – End Date for filtering

GetNewsletterSummary(newsletterid, statid, from, to);

$ http GET "https://api.mailmailmail.net/v1.1/Stats/GetNewsletterSummary?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&newsletterid=value&statid=value&from=value&to=value"

Returns:

On success:

<StatsObj> Details about the Statistics entry.

On failure:

<String> message

Examples:

$ http GET "https://api.mailmailmail.net/v1.1/Stats/GetNewsletterSummary?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&newsletterid=56"

int newsletterid = 56;

object result = parser.GetNewsletterSummary(newsletterid);

int newsletterid = 56;
string from = "30-04-2018";

object result = parser.GetNewsletterSummary(newsletterid, 0, from);

int newsletterid = 56;
string to = "30-09-2018";

object result = parser.GetNewsletterSummary(newsletterid, 0, "", to);

ViewNewsletter

View newsletter data.

Parametres:

• <Integer> newsletterid – ID of the newsletter about which you require more details. [Required]

ViewNewsletter(newsletterid);

$ http GET "https://api.mailmailmail.net/v1.1/Newsletters/ViewNewsletter?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&newsletterid=value"

Returns:

On success:

<Array> Newsletter details.

On failure:

<Array> array(false, message)

Examples:

$ http GET "https://api.mailmailmail.net/v1.1/Newsletters/ViewNewsletter?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&newsletterid=12"

int newsletterid = 12; 

object result = parser.ViewNewsletter(newsletterid);

EditNewsletter

Change newsletter name and subject

Parametres:

• <Integer> newsletterid – ID of the newsletter. [Required]
• <String> newsletterName – Name on newsletter.
• <String> newsletterSubject – Subject on newsletter.

EditNewsletter(newsletterid, newsletterName, newsletterSubject);

$ http POST https://api.mailmailmail.net/v1.1/Newsletters/EditNewsletter --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&newsletterid=value&name=value&subject=value"

Returns:

On success:

 <Boolean> true

On failure:

 <Boolean> false

Examples:

$ http POST https://api.mailmailmail.net/v1.1/Newsletters/EditNewsletter --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&newsletterid=15&name=Newsletter"

int newsletterid = 15;
string newsletterName = "Newsletter";

object result = parser.EditNewsletter(newsletterid, newsletterName);

int newsletterid = 15;
string newsletterName = "Newsletter";
string newsletterSubject = "Subject";

object result = parser.EditNewsletter(newsletterid, newsletterName, newsletterSubject);

CopyNewsletter

Copy a newsletter along with attachments, images etc.

Parametres:

• <Integer> newsletterid – ID of the newsletter. [Required]
• <String> newsletterName – Name on newsletter.
• <String> newsletterSubject – Subject on newsletter.

CopyNewsletter(newsletterid, newsletterName, newsletterSubject);

$ http POST https://api.mailmailmail.net/v1.1/Newsletters/CopyNewsletter --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&oldid=value&name=value&subject=value"

Returns:

On success:

 <Array> {true, "new id"}

On failure:

 <Array> {false, false}

Examples:

$ http POST https://api.mailmailmail.net/v1.1/Newsletters/CopyNewsletter --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&oldid=15&name=Newsletter"

int newsletterid = 15;
string newsletterName = "Newsletter";
object result = parser.CopyNewsletter(newsletterid, newsletterName);

int newsletterid = 23;
object result = parser.CopyNewsletter(newsletterid);

int newsletterid = 23;
string newsletterName = "Newsletter";
string newsletterSubject = "Subject";
object result = parser.CopyNewsletter(newsletterid, newsletterName, newsletterSubject);

GetTriggerSummary

Calculates the total number of Emails sent, Bounces, Unsubscribes, Opens, Forwards and Link Clicks for Trigger

Parametres:

• <Integer> triggerid – ID of the trigger. [Required]
• <String> from – Start Date for filtering
• <String> to – End Date for filtering

GetTriggerSummary(triggerid, from, to);

$ http GET "https://api.mailmailmail.net/v1.1/Triggers/GetTriggerSummary?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&triggerid=value&from=value&to=value"

Returns:

On success:

<StatsObj> Details about the Statistics entry.

On failure:

<Boolean> false

Examples:

$ http GET "https://api.mailmailmail.net/v1.1/Triggers/GetTriggerSummary?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&triggerid=56&from=30-05-2017"

int triggerid = 56;

object result = parser.GetTriggerSummary(triggerid);

int triggerid = 56;
string from = "30-04-2018";

object result = parser.GetTriggerSummary(triggerid,from);

int triggerid = 56;
string to = "30-09-2018";

object result = parser.GetTriggerSummary(triggerid,"",to);

SetTriggerStatus

Activate/Deactivate Trigger.

Parametres:

• <Integer> triggerid – ID of the Trigger. [Required]
• <Boolean> status – new status for trigger

SetTriggerStatus(triggerid, status);

$ http POST https://api.mailmailmail.net/v1.1/Triggers/SetTriggerStatus --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&triggerid=value&status=value"

Returns:

On success:

 <Boolean> true

On failure:

 <Boolean> false

Examples:

$ http POST https://api.mailmailmail.net/v1.1/Triggers/SetTriggerStatus --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&triggerid=15&status=true"

int triggerid = 15;
bool status = true;
object result = parser.SetTriggerStatus(triggerid, status);

int triggerid = 15;
bool status = false;
object result = parser.SetTriggerStatus(triggerid, status);

GetAutoresponderSummary

Calculates the total number of Emails sent, Bounces, Unsubscribes, Opens, Forwards and Link Clicks for Autoresponder

Parametres:

• <Integer> autoresponderid – ID of the autoresponder. [Required]
• <String> from – Start Date for filtering
• <String> to – End Date for filtering

GetAutoresponderSummary(autoresponderid, from, to);

$ http GET "https://api.mailmailmail.net/v1.1/Autoresponders/GetAutoresponderSummary?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&autoresponderid=value&from=value&to=value"

Returns:

On success:

<StatsObj> Details about the Statistics entry.

On failure:

<Boolean> false

Examples:

$ http GET "https://api.mailmailmail.net/v1.1/Autoresponders/GetAutoresponderSummary?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&autoresponderid=56&from=30-05-2017"

int autoresponderid = 56;

object result = parser.GetAutoresponderSummary(autoresponderid);

int autoresponderid = 56;
string from = "30-04-2018";

object result = parser.GetAutoresponderSummary(autoresponderid,from);

int autoresponderid = 56;
string to = "30-09-2018";

object result = parser.GetAutoresponderSummary(autoresponderid,"",to);

SetAutoresponderStatus

Activate/Deactivate Autoresponder.

Parametres:

• <Integer> autoresponderid – ID of the Autoresponder [Required]
• <Boolean> status – new status for autoresponder

SetAutoresponderStatus(autoresponderid, status);

$ http POST https://api.mailmailmail.net/v1.1/Autoresponders/SetAutoresponderStatus --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&autoresponderid=value&status=value"

Returns:

On success:

 <Boolean> true

On failure:

 <Boolean> false

Examples:

$ http POST https://api.mailmailmail.net/v1.1/Autoresponders/SetAutoresponderStatus --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&autoresponderid=15&status=true"

int autoresponderid = 15;
bool status = true;
object result = parser.SetAutoresponderStatus(autoresponderid, status);

int autoresponderid = 15;
bool status = false;
object result = parser.SetAutoresponderStatus(autoresponderid, status);

GetLeadScore

Get lead score for subscriber.

Parametres:

• <Integer> subscriberid – ID of subscriber [Required]

GetLeadScore(subscriberid);

$ http POST https://api.mailmailmail.net/v1.1/Subscribers/GetLeadScore --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&subscriberid=value"

Returns:

On success:

 <Integer> lead score

On failure:

 <Array> (false, message)

Examples:

$ http POST https://api.mailmailmail.net/v1.1/Subscribers/GetLeadScore --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&subscriberid=15"

int subscriberid = 15;
object result = parser.GetLeadScore(subscriberid);

SetLeadScore

Set lead score for subscrbier.

Parametres:

• <Integer> subscriberid – ID of subscriber [Required]
• <Integer> leadScore – Lead score for subscriber [Required]
• <String> set – How to set lead score add/reduce/overwrite [Default is add]

SetLeadScore(subscriberid, leadScore, set);

$ http POST https://api.mailmailmail.net/v1.1/Subscribers/AddToLeadScore --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&subscriberid=value&leadScore=value&set=value"

Returns:

On success:

 <Boolean> true

On failure:

 <Array> (false, message)

Examples:

$ http POST https://api.mailmailmail.net/v1.1/Subscribers/SetLeadScore --data "Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&subscriberid=15&leadScore=100&set=overwrite"

int subscriberid = 15;
int leadScore = 100;
string set = "overwrite";
object result = parser.SetLeadScore(subscriberid, leadScore, set);

GetSentEmailCampaignEvents

Fetch events for sent campaigns based on user.

Parametres:

• <String> from – Event date [Required]
• <String> to – Event date
• <Integer> limit – Number of records you want to fetch. [Default is 10, Maximum is 1000]
• <Integer> offset – From where to start.

GetSentEmailCampaignEvents(from, to, limit, offset);

$ http GET https://api.mailmailmail.net/v1.1/Events/GetSentEmailCampaignEvents?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&from=value&to=value&limit=value&offset=value"

Returns:

On success:

 <Array> Events

On failure:

 <Array> (false, message)

Examples:

$ http GET https://api.mailmailmail.net/v1.1/Events/GetSentEmailCampaignEvents?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&from=25.10.2019&to=27.10.2019&limit=100&offset=0"

string from = "25.10.2019";
string to = "27.10.2019";
int limit = 100;
int offset = 0;
object result = parser.GetSentEmailCampaignEvents(from, to, limit, offset);

GetSentEmailCampaignWithTriggerEvents

Fetch events for sent campaigns with trigger based on user.

Parametres:

• <String> from – Event date [Required]
• <String> to – Event date
• <Integer> limit – Number of records you want to fetch. [Default is 10, Maximum is 1000]
• <Integer> offset – From where to start.

GetSentEmailCampaignWithTriggerEvents(from, to, limit, offset);

$ http GET https://api.mailmailmail.net/v1.1/Events/GetSentEmailCampaignWithTriggerEvents?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&from=value&to=value&limit=value&offset=value"

Returns:

On success:

 <Array> Events

On failure:

 <Array> (false, message)

Examples:

$ http GET https://api.mailmailmail.net/v1.1/Events/GetSentEmailCampaignWithTriggerEvents?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&from=25.10.2019&to=27.10.2019&limit=100&offset=0"

string from = "25.10.2019";
string to = "27.10.2019";
int limit = 100;
int offset = 0;
object result = parser.GetSentEmailCampaignEvents(from, to, limit, offset);

GetOpenCampaignEvents

Fetch events for open campaigns based on user.

Parametres:

• <String> from – Event date [Required]
• <String> to – Event date
• <Integer> limit – Number of records you want to fetch. [Default is 10, Maximum is 1000]
• <Integer> offset – From where to start.

GetOpenCampaignEvents(from, to, limit, offset);

$ http GET https://api.mailmailmail.net/v1.1/Events/GetOpenCampaignEvents?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&from=value&to=value&limit=value&offset=value"

Returns:

On success:

 <Array> Events

On failure:

 <Array> (false, message)

Examples:

$ http GET https://api.mailmailmail.net/v1.1/Events/GetOpenCampaignEvents?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&from=25.10.2019&to=27.10.2019&limit=100&offset=0"

string from = "25.10.2019";
string to = "27.10.2019";
int limit = 100;
int offset = 0;
object result = parser.GetSentEmailCampaignEvents(from, to, limit, offset);

GetOpenTriggersEvents

Fetch events for open campaigns sent with trigger based on user.

Parametres:

• <String> from – Event date [Required]
• <String> to – Event date
• <Integer> limit – Number of records you want to fetch. [Default is 10, Maximum is 1000]
• <Integer> offset – From where to start.

GetOpenTriggersEvents(from, to, limit, offset);

$ http GET https://api.mailmailmail.net/v1.1/Events/GetOpenTriggersEvents?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&from=value&to=value&limit=value&offset=value"

Returns:

On success:

 <Array> Events

On failure:

 <Array> (false, message)

Examples:

$ http GET https://api.mailmailmail.net/v1.1/Events/GetOpenTriggersEvents?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&from=25.10.2019&to=27.10.2019&limit=100&offset=0"

string from = "25.10.2019";
string to = "27.10.2019";
int limit = 100;
int offset = 0;
object result = parser.GetSentEmailCampaignEvents(from, to, limit, offset);

GetLinkClickCampaignEvents

Fetch events for link click in campaigns based on user.

Parametres:

• <String> from – Event date [Required]
• <String> to – Event date
• <Integer> limit – Number of records you want to fetch. [Default is 10, Maximum is 1000]
• <Integer> offset – From where to start.

GetLinkClickCampaignEvents(from, to, limit, offset);

$ http GET https://api.mailmailmail.net/v1.1/Events/GetLinkClickCampaignEvents?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&from=value&to=value&limit=value&offset=value"

Returns:

On success:

 <Array> Events

On failure:

 <Array> (false, message)

Examples:

$ http GET https://api.mailmailmail.net/v1.1/Events/GetLinkClickCampaignEvents?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&from=25.10.2019&to=27.10.2019&limit=100&offset=0"

string from = "25.10.2019";
string to = "27.10.2019";
int limit = 100;
int offset = 0;
object result = parser.GetSentEmailCampaignEvents(from, to, limit, offset);

GetLinkClickTriggerEvents

Fetch events for link click in campaigns sent with trigger based on user.

Parametres:

• <String> from – Event date [Required]
• <String> to – Event date
• <Integer> limit – Number of records you want to fetch. [Default is 10, Maximum is 1000]
• <Integer> offset – From where to start.

GetLinkClickTriggerEvents(from, to, limit, offset);

$ http GET https://api.mailmailmail.net/v1.1/Events/GetLinkClickTriggerEvents?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&from=value&to=value&limit=value&offset=value"

Returns:

On success:

 <Array> Events

On failure:

 <Array> (false, message)

Examples:

$ http GET https://api.mailmailmail.net/v1.1/Events/GetLinkClickTriggerEvents?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&from=25.10.2019&to=27.10.2019&limit=100&offset=0"

string from = "25.10.2019";
string to = "27.10.2019";
int limit = 100;
int offset = 0;
object result = parser.GetSentEmailCampaignEvents(from, to, limit, offset);

GetSentAutoresponderEvents

Fetch events for sent autoresponders based on user.

Parametres:

• <String> from – Event date [Required]
• <String> to – Event date
• <Integer> limit – Number of records you want to fetch. [Default is 10, Maximum is 1000]
• <Integer> offset – From where to start.

GetSentAutoresponderEvents(from, to, limit, offset);

$ http GET https://api.mailmailmail.net/v1.1/Events/GetSentAutoresponderEvents?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&from=value&to=value&limit=value&offset=value"

Returns:

On success:

 <Array> Events

On failure:

 <Array> (false, message)

Examples:

$ http GET https://api.mailmailmail.net/v1.1/Events/GetSentAutoresponderEvents?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&from=25.10.2019&to=27.10.2019&limit=100&offset=0"

string from = "25.10.2019";
string to = "27.10.2019";
int limit = 100;
int offset = 0;
object result = parser.GetSentEmailCampaignEvents(from, to, limit, offset);

GetOpenAutoresponderEvents

Fetch events for opened autoresponders based on user.

Parametres:

• <String> from – Event date [Required]
• <String> to – Event date
• <Integer> limit – Number of records you want to fetch. [Default is 10, Maximum is 1000]
• <Integer> offset – From where to start.

GetOpenAutoresponderEvents(from, to, limit, offset);

$ http GET https://api.mailmailmail.net/v1.1/Events/GetOpenAutoresponderEvents?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&from=value&to=value&limit=value&offset=value"

Returns:

On success:

 <Array> Events

On failure:

 <Array> (false, message)

Examples:

$ http GET https://api.mailmailmail.net/v1.1/Events/GetOpenAutoresponderEvents?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&from=25.10.2019&to=27.10.2019&limit=100&offset=0"

string from = "25.10.2019";
string to = "27.10.2019";
int limit = 100;
int offset = 0;
object result = parser.GetSentEmailCampaignEvents(from, to, limit, offset);

GetLinkClickAutoresponderEvents

Fetch events for link click in autoresponders based on user.

Parametres:

• <String> from – Event date [Required]
• <String> to – Event date
• <Integer> limit – Number of records you want to fetch. [Default is 10, Maximum is 1000]
• <Integer> offset – From where to start.

GetLinkClickAutoresponderEvents(from, to, limit, offset);

$ http GET https://api.mailmailmail.net/v1.1/Events/GetLinkClickAutoresponderEvents?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&from=value&to=value&limit=value&offset=value"

Returns:

On success:

 <Array> Events

On failure:

 <Array> (false, message)

Examples:

$ http GET https://api.mailmailmail.net/v1.1/Events/GetLinkClickAutoresponderEvents?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&from=25.10.2019&to=27.10.2019&limit=100&offset=0"

string from = "25.10.2019";
string to = "27.10.2019";
int limit = 100;
int offset = 0;
object result = parser.GetSentEmailCampaignEvents(from, to, limit, offset);

GetSentSMSCampaignEvents

Fetch events for link click in autoresponders based on user.

Parametres:

• <String> from – Event date [Required]
• <String> to – Event date
• <Integer> limit – Number of records you want to fetch. [Default is 10, Maximum is 1000]
• <Integer> offset – From where to start.

GetSentSMSCampaignEvents(from, to, limit, offset);

$ http GET https://api.mailmailmail.net/v1.1/Events/GetSentSMSCampaignEvents?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&from=value&to=value&limit=value&offset=value"

Returns:

On success:

 <Array> Events

On failure:

 <Array> (false, message)

Examples:

$ http GET https://api.mailmailmail.net/v1.1/Events/GetSentSMSCampaignEvents?Apiusername=YOUR_API_USERNAME&Apitoken=YOUR_API_TOKEN&from=25.10.2019&to=27.10.2019&limit=100&offset=0"

string from = "25.10.2019";
string to = "27.10.2019";
int limit = 100;
int offset = 0;
object result = parser.GetSentEmailCampaignEvents(from, to, limit, offset);