Sunteți pe pagina 1din 91
Mailpro™ Email & SMS Marketing API JSON & XML V2.3.4 Last update 05.09.2019 1
Mailpro™ Email & SMS Marketing API JSON & XML V2.3.4 Last update 05.09.2019
Mailpro™
Email & SMS Marketing
API
JSON & XML
V2.3.4
Last update 05.09.2019
INTRODUCTION Dear Mailpro User, Please find here our application programming interface (API) intended to be
INTRODUCTION Dear Mailpro User, Please find here our application programming interface (API) intended to be
INTRODUCTION
Dear Mailpro User,
Please find here our application programming interface (API) intended to be used as interface with your
application / website component to communicate with Mailpro to send email and optimize your email
deliverability.
You can find the latest version of this document in your Mailpro Account. You can set-up a free account
in order to receive the documentation.
In order to use the API and for security reasons, our support team has to give you and validate your API
Key if you are a free account, so please fill this validation form.
If you are a paid account you can find your API Key inside Mailpro in Configuration->API.
In order to use some of the API methods you will need the Ids of several Mailpro objects, like messages,
address books, campaigns and sender emails. You can find these Ids in all the lists inside Mailpro (as a
column or in the list menu)
And your customer/client Id you can find it inside Mailpro in the top banner or in My Account module.
The client ID is an only number value, so omit any letter.
If you have any doubt please contact us by email: support@mailpro.com.
Thanks for linking Mailpro and enjoy!
Mailpro Development Team
doubt please contact us by email: support@mailpro.com. Thanks for linking Mailpro and enjoy! Mailpro Development Team
Mailpro API: Email Functions Page 5 to 74 By default, you can call all functions
Mailpro API: Email Functions Page 5 to 74 By default, you can call all functions
Mailpro API: Email Functions
Page 5 to 74
By default, you can call all functions at max speed of 500 requests per minute on the API.
API Functions
List
Add
Addressbook
Del
Edit
List
Add
Emails
AddSingle
Del
Edit
List
Add
Message
Del
Edit
List
Del
Add
Send
AddSingle
AddSingle2
SendingTest
List
Add
TransactionalEmail
Del
Edit
SetStatus
Historic
List
List
SenderEmail
Del
List
Del
ByHour
ByDay
Open
Stats
Click
System
EmailSoftare
Country
BadMail
Credits
Account
SubscriptionEndDate
PHP
ASP.Net
Code Example
Java
Visual Basic
EmailSoftare Country BadMail Credits Account SubscriptionEndDate PHP ASP.Net Code Example Java Visual Basic 3
Mailpro API: SMS Functions Page 75 to 91 By default, you can call all functions
Mailpro API: SMS Functions Page 75 to 91 By default, you can call all functions
Mailpro API: SMS Functions
Page 75 to 91
By default, you can call all functions at max speed of 500 requests per minute on the API.
API Functions SMS
List
Add
Addressbook
Del
Edit
List
Add
Phones
Del
Edit
List
Del
Send
Add
AddSingle
Historic
List
Credits
Get Credits
Del Edit List Add Phones Del Edit List Del Send Add AddSingle Historic List Credits Get
  EMAIL LIST ADDRESSBOOK Description: Get a listing of all Address Books Method: Get Call:
  EMAIL LIST ADDRESSBOOK Description: Get a listing of all Address Books Method: Get Call:
 
EMAIL
EMAIL
EMAIL

EMAIL

LIST ADDRESSBOOK

Description: Get a listing of all Address Books Method: Get

Call:

LIST ADDRESSBOOK Description: Get a listing of all Address Books Method: Get Call:
LIST ADDRESSBOOK Description: Get a listing of all Address Books Method: Get Call:
LIST ADDRESSBOOK Description: Get a listing of all Address Books Method: Get Call:
LIST ADDRESSBOOK Description: Get a listing of all Address Books Method: Get Call:
LIST ADDRESSBOOK Description: Get a listing of all Address Books Method: Get Call:
LIST ADDRESSBOOK Description: Get a listing of all Address Books Method: Get Call:
LIST ADDRESSBOOK Description: Get a listing of all Address Books Method: Get Call:
LIST ADDRESSBOOK Description: Get a listing of all Address Books Method: Get Call:
LIST ADDRESSBOOK Description: Get a listing of all Address Books Method: Get Call:
LIST ADDRESSBOOK Description: Get a listing of all Address Books Method: Get Call:
 

Base URL

 
https://api.mailpro.com/v2/addressbook/list.xml

https://api.mailpro.com/v2/addressbook/list.xml

https://api.mailpro.com/v2/addressbook/list.xml
https://api.mailpro.com/v2/addressbook/list.xml
https://api.mailpro.com/v2/addressbook/list.xml
 

Parameters

 
 

Name

   

Mandatory

Description
Description
Description
Description

Description

Description
Description
Description
Description

IdClient

   

YES

This is a unique ID for identify the client
This is a unique ID for identify the client
This is a unique ID for identify the client

This is a unique ID for identify the client

This is a unique ID for identify the client
This is a unique ID for identify the client
This is a unique ID for identify the client
This is a unique ID for identify the client
 

ApiKey

   

YES

This is a GUID to identify the client and for access to the API
This is a GUID to identify the client and for access to the API
This is a GUID to identify the client and for access to the API
This is a GUID to identify the client and for access to the API

This is a GUID to identify the client and for access to the API

This is a GUID to identify the client and for access to the API
This is a GUID to identify the client and for access to the API
 

TitleFilter

   

NO

Text to filter the results
Text to filter the results

Text to filter the results

Text to filter the results
Text to filter the results
Text to filter the results
Text to filter the results
Text to filter the results
Text to filter the results
 

Type

   

NO

If present, only Unsubscription address books (0) or subscription address books (1) are returned
If present, only Unsubscription address books (0) or subscription address books (1) are returned
If present, only Unsubscription address books (0) or subscription address books (1) are returned
If present, only Unsubscription address books (0) or subscription address books (1) are returned
If present, only Unsubscription address books (0) or subscription address books (1) are returned
If present, only Unsubscription address books (0) or subscription address books (1) are returned
If present, only Unsubscription address books (0) or subscription address books (1) are returned

If present, only Unsubscription address books (0) or subscription address books (1) are returned

If present, only Unsubscription address books (0) or subscription address books (1) are returned

NumberOfRecords

 

NO

By Default: 100 Items. If 0 return All. If PageNumber is used, it determines the
By Default: 100 Items. If 0 return All. If PageNumber is used, it determines the
By Default: 100 Items. If 0 return All. If PageNumber is used, it determines the
By Default: 100 Items. If 0 return All. If PageNumber is used, it determines the
By Default: 100 Items. If 0 return All. If PageNumber is used, it determines the
By Default: 100 Items. If 0 return All. If PageNumber is used, it determines the
By Default: 100 Items. If 0 return All. If PageNumber is used, it determines the

By Default: 100 Items. If 0 return All. If PageNumber is used, it determines the page size (number of records per page)

By Default: 100 Items. If 0 return All. If PageNumber is used, it determines the page
By Default: 100 Items. If 0 return All. If PageNumber is used, it determines the page
By Default: 100 Items. If 0 return All. If PageNumber is used, it determines the page
By Default: 100 Items. If 0 return All. If PageNumber is used, it determines the page
By Default: 100 Items. If 0 return All. If PageNumber is used, it determines the page
By Default: 100 Items. If 0 return All. If PageNumber is used, it determines the page
By Default: 100 Items. If 0 return All. If PageNumber is used, it determines the page
By Default: 100 Items. If 0 return All. If PageNumber is used, it determines the page
By Default: 100 Items. If 0 return All. If PageNumber is used, it determines the page

PageNumber

   

NO

Indicates the requested page number. It’s necessary to use with the parameter NumberOfRecords

Indicates the requested page number. It’s necessary to use with the parameter NumberOfRecords
Indicates the requested page number. It’s necessary to use with the parameter NumberOfRecords
Indicates the requested page number. It’s necessary to use with the parameter NumberOfRecords
Indicates the requested page number. It’s necessary to use with the parameter NumberOfRecords
Indicates the requested page number. It’s necessary to use with the parameter NumberOfRecords
Indicates the requested page number. It’s necessary to use with the parameter NumberOfRecords
Indicates the requested page number. It’s necessary to use with the parameter NumberOfRecords
Indicates the requested page number. It’s necessary to use with the parameter NumberOfRecords
Indicates the requested page number. It’s necessary to use with the parameter NumberOfRecords
Indicates the requested page number. It’s necessary to use with the parameter NumberOfRecords
 

SortByName

   

NO

Default false (and then sort by Creation Date Desc)
Default false (and then sort by Creation Date Desc)
Default false (and then sort by Creation Date Desc)
Default false (and then sort by Creation Date Desc)

Default false (and then sort by Creation Date Desc)

Default false (and then sort by Creation Date Desc)
Default false (and then sort by Creation Date Desc)
Default false (and then sort by Creation Date Desc)

Result attributes:

 
Result attributes:  
Result attributes:  
Result attributes:  
Result attributes:  
Result attributes:  
Result attributes:  
Result attributes:  
Result attributes:  
 

Name

 

Description

 

AddressBooks[]

 

Contains list of address books

Contains list of address books
Contains list of address books
Contains list of address books
Contains list of address books
Contains list of address books
Contains list of address books
Contains list of address books
 
 

AddressBook[]

 

Identify each address book

 
 

AddressBookId

 

ID of the address book

ID of the address book
ID of the address book
ID of the address book
ID of the address book
ID of the address book
ID of the address book
 

CreationDate

 

Creation date of this address book Format : YYYY-MM-DDThh:mm:ss (ISO format)

Creation date of this address book Format : YYYY-MM-DDThh:mm:ss (ISO format)
Creation date of this address book Format : YYYY-MM-DDThh:mm:ss (ISO format)
Creation date of this address book Format : YYYY-MM-DDThh:mm:ss (ISO format)
 

Title

 

Title of address book

Type

 
1 for Unsubscription address book, 0 for subscription address book

1 for Unsubscription address book, 0 for subscription address book

1 for Unsubscription address book, 0 for subscription address book
 

NumberEmails

 

Number of email in this address book

 
 
 
 
subscription address book   NumberEmails   Number of email in this address book      
subscription address book   NumberEmails   Number of email in this address book      
subscription address book   NumberEmails   Number of email in this address book      
subscription address book   NumberEmails   Number of email in this address book      
subscription address book   NumberEmails   Number of email in this address book      
subscription address book   NumberEmails   Number of email in this address book      
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
address book   NumberEmails   Number of email in this address book       5
address book   NumberEmails   Number of email in this address book       5
Example of result: <?xml version='1.0' encoding='UTF-8'?> <mailproapi
Example of result: <?xml version='1.0' encoding='UTF-8'?> <mailproapi
Example of result:
<?xml version='1.0' encoding='UTF-8'?>
<mailproapi version="1">
<AddressBooks>
<AddressBook>
<AddressBookID>1025</AddressBookID>
<CreationDate>2012-01-02T01:00:00</CreationDate>
<Title>Example</Title>
<Type>1</Type>
<NumberEmails>545</NumberEmails>
</AddressBook>
<AddressBook>
<AddressBookID>1026</AddressBookID>
<CreationDate>2012-01-02T01:00:00</CreationDate>
<Title>Example2</Title>
<Type>0</Type>
<NumberEmails>2540</NumberEmails>
</AddressBook>
</AddressBooks>
</mailproapi>
</AddressBook> </AddressBooks> </mailproapi> 6
ADD ADDRESSBOOK EMAIL Description: Add an address book (Maximum 100 Address Books) Method: Post Call:
ADD ADDRESSBOOK EMAIL Description: Add an address book (Maximum 100 Address Books) Method: Post Call:

ADD ADDRESSBOOK

ADD ADDRESSBOOK EMAIL Description: Add an address book (Maximum 100 Address Books) Method: Post Call: Base
EMAIL
EMAIL

EMAIL

EMAIL

Description: Add an address book (Maximum 100 Address Books) Method: Post

Call:

Description: Add an address book (Maximum 100 Address Books) Method: Post Call:
Description: Add an address book (Maximum 100 Address Books) Method: Post Call:
Description: Add an address book (Maximum 100 Address Books) Method: Post Call:

Base URL

https://api.mailpro.com/v2/addressbook/add.xml

https://api.mailpro.com/v2/addressbook/add.xml

https://api.mailpro.com/v2/addressbook/add.xml
https://api.mailpro.com/v2/addressbook/add.xml
https://api.mailpro.com/v2/addressbook/add.xml
https://api.mailpro.com/v2/addressbook/add.xml
https://api.mailpro.com/v2/addressbook/add.xml
https://api.mailpro.com/v2/addressbook/add.xml
 

Parameters

Name

Mandatory

Description

Description

Description
Description
Description

IdClient

YES

This is a unique ID for identify the client
This is a unique ID for identify the client
This is a unique ID for identify the client

This is a unique ID for identify the client

This is a unique ID for identify the client
This is a unique ID for identify the client
This is a unique ID for identify the client
This is a unique ID for identify the client
This is a unique ID for identify the client

ApiKey

YES

This is a GUID to identify the client and for access to the API
This is a GUID to identify the client and for access to the API
This is a GUID to identify the client and for access to the API
This is a GUID to identify the client and for access to the API

This is a GUID to identify the client and for access to the API

This is a GUID to identify the client and for access to the API
This is a GUID to identify the client and for access to the API
This is a GUID to identify the client and for access to the API

Type

NO

If present, only unsubscription address books (0) or subscription address books (1) are added
If present, only unsubscription address books (0) or subscription address books (1) are added
If present, only unsubscription address books (0) or subscription address books (1) are added
If present, only unsubscription address books (0) or subscription address books (1) are added
If present, only unsubscription address books (0) or subscription address books (1) are added

If present, only unsubscription address books (0) or subscription address books (1) are added

If present, only unsubscription address books (0) or subscription address books (1) are added

Title

YES

The title of address book

The title of address book

The title of address book
The title of address book
The title of address book
The title of address book
The title of address book
The title of address book
The title of address book
 

Result attributes:

 
  Result attributes:  
  Result attributes:  
  Result attributes:  
  Result attributes:  
  Result attributes:  
  Result attributes:  
  Result attributes:  
  Result attributes:  
 

Name

   
  Name     Description
Description
Description
Description

Description

Description
  Name     Description
  Name     Description
  Name     Description
  Name     Description

AddressBooks[]

 

Contains list of address books

 
   

AddressBook[]

 
Identify each address book

Identify each address book

Identify each address book
Identify each address book
    AddressBook[]   Identify each address book
    AddressBook[]   Identify each address book
    AddressBook[]   Identify each address book
    AddressBook[]   Identify each address book
 

AddressBookId

 

ID of the address book

 

CreationDate

 
Creation date of this address book Format : YYYY-MM-DDThh:mm:ss (ISO format)
Creation date of this address book Format : YYYY-MM-DDThh:mm:ss (ISO format)
Creation date of this address book Format : YYYY-MM-DDThh:mm:ss (ISO format)
Creation date of this address book Format : YYYY-MM-DDThh:mm:ss (ISO format)

Creation date of this address book Format : YYYY-MM-DDThh:mm:ss (ISO format)

Creation date of this address book Format : YYYY-MM-DDThh:mm:ss (ISO format)
CreationDate   Creation date of this address book Format : YYYY-MM-DDThh:mm:ss (ISO format)
CreationDate   Creation date of this address book Format : YYYY-MM-DDThh:mm:ss (ISO format)
CreationDate   Creation date of this address book Format : YYYY-MM-DDThh:mm:ss (ISO format)
CreationDate   Creation date of this address book Format : YYYY-MM-DDThh:mm:ss (ISO format)
CreationDate   Creation date of this address book Format : YYYY-MM-DDThh:mm:ss (ISO format)

Title

Title of address book

Title of address book
Title of address book
Title of address book
 
Title Title of address book  
Title Title of address book  
Title Title of address book  
Title Title of address book  

Type

 

1 for Unsubscription address book, 0 for subscription address book

 

NumberEmails

 
Number of email in this address book
Number of email in this address book

Number of email in this address book

Number of email in this address book
NumberEmails   Number of email in this address book
NumberEmails   Number of email in this address book
NumberEmails   Number of email in this address book
NumberEmails   Number of email in this address book
NumberEmails   Number of email in this address book

Example of result:

 
Example of result:  
Example of result:  
Example of result:  
Example of result:  
Example of result:  
Example of result:  
Example of result:  

<?xml version='1.0' encoding='UTF-8'?>

 
<?xml version='1.0' encoding='UTF-8'?>  
<?xml version='1.0' encoding='UTF-8'?>  
<?xml version='1.0' encoding='UTF-8'?>  
<?xml version='1.0' encoding='UTF-8'?>  
<?xml version='1.0' encoding='UTF-8'?>  
<?xml version='1.0' encoding='UTF-8'?>  
<?xml version='1.0' encoding='UTF-8'?>  
<?xml version='1.0' encoding='UTF-8'?>  

<mailproapi version="1"> <AddressBooks> <AddressBook>

<AddressBooks> <AddressBook> <AddressBookID>1026</AddressBookID>
<AddressBooks> <AddressBook> <AddressBookID>1026</AddressBookID>

<AddressBookID>1026</AddressBookID>

<CreationDate>2012-01-02T01:00:00</CreationDate>

<AddressBookID>1026</AddressBookID> <CreationDate>2012-01-02T01:00:00</CreationDate>
 

<Title>Example2</Title>

   

<Type>0</Type>

<Type>0</Type>
<Type>0</Type>
<Type>0</Type>
<Type>0</Type>

<NumberEmails>0</NumberEmails>

 
 

</AddressBook>

</AddressBooks>

 
 

</mailproapi>

 
 
 
 
    </AddressBook> </AddressBooks>     </mailproapi>    
    </AddressBook> </AddressBooks>     </mailproapi>    
    </AddressBook> </AddressBooks>     </mailproapi>    
    </AddressBook> </AddressBooks>     </mailproapi>    
    </AddressBook> </AddressBooks>     </mailproapi>    
    </AddressBook> </AddressBooks>     </mailproapi>    
    </AddressBook> </AddressBooks>     </mailproapi>    
    </AddressBook> </AddressBooks>     </mailproapi>    
    </AddressBook> </AddressBooks>     </mailproapi>    
    </AddressBook> </AddressBooks>     </mailproapi>    
    </AddressBook> </AddressBooks>     </mailproapi>    
    </AddressBook> </AddressBooks>     </mailproapi>    
    </AddressBook> </AddressBooks>     </mailproapi>    
    </AddressBook> </AddressBooks>     </mailproapi>    
    </AddressBook> </AddressBooks>     </mailproapi>    
    </AddressBook> </AddressBooks>     </mailproapi>    
    </AddressBook> </AddressBooks>     </mailproapi>    
    </AddressBook> </AddressBooks>     </mailproapi>    
    </AddressBook> </AddressBooks>     </mailproapi>    
  </AddressBook> </AddressBooks>     </mailproapi>     7
DELETE ADDRESSBOOK     EMAIL Description: Delete an address Book Method: Post Call:   Base
DELETE ADDRESSBOOK     EMAIL Description: Delete an address Book Method: Post Call:   Base

DELETE ADDRESSBOOK

DELETE ADDRESSBOOK     EMAIL Description: Delete an address Book Method: Post Call:   Base URL
   
    EMAIL
EMAIL
EMAIL

EMAIL

Description: Delete an address Book Method: Post

Call:

 
Description: Delete an address Book Method: Post Call:  
Description: Delete an address Book Method: Post Call:  
Description: Delete an address Book Method: Post Call:  

Base URL

 
https://api.mailpro.com/v2/addressbook/del.xml

https://api.mailpro.com/v2/addressbook/del.xml

https://api.mailpro.com/v2/addressbook/del.xml
https://api.mailpro.com/v2/addressbook/del.xml
Base URL   https://api.mailpro.com/v2/addressbook/del.xml
Base URL   https://api.mailpro.com/v2/addressbook/del.xml
Base URL   https://api.mailpro.com/v2/addressbook/del.xml
Base URL   https://api.mailpro.com/v2/addressbook/del.xml
 

Parameters

Name

 

Mandatory

 
Description

Description

Name   Mandatory   Description
Name   Mandatory   Description
Name   Mandatory   Description

IdClient

 

YES

 
This is a unique ID for identify the client
This is a unique ID for identify the client
This is a unique ID for identify the client

This is a unique ID for identify the client

This is a unique ID for identify the client
IdClient   YES   This is a unique ID for identify the client
IdClient   YES   This is a unique ID for identify the client
IdClient   YES   This is a unique ID for identify the client
IdClient   YES   This is a unique ID for identify the client

ApiKey

 

YES

 
This is a GUID to identify the client and for access to the API
This is a GUID to identify the client and for access to the API
This is a GUID to identify the client and for access to the API
This is a GUID to identify the client and for access to the API
This is a GUID to identify the client and for access to the API

This is a GUID to identify the client and for access to the API

This is a GUID to identify the client and for access to the API
ApiKey   YES   This is a GUID to identify the client and for access to

AddressBookId

   

YES

 

ID of the address book

ID of the address book
ID of the address book
AddressBookId     YES   ID of the address book
AddressBookId     YES   ID of the address book
AddressBookId     YES   ID of the address book
AddressBookId     YES   ID of the address book

Result attributes:

 
Result attributes:  
Result attributes:  
Result attributes:  
Result attributes:  
Result attributes:  
Result attributes:  
Result attributes:  
Result attributes:  
 

Name

 
Description
Description
Description

Description

Description
  Name   Description
  Name   Description
  Name   Description
  Name   Description

Result

Result of action

 

Example of result:

 
Example of result:  
Example of result:  
Example of result:  
Example of result:  
Example of result:  
Example of result:  
Example of result:  
Example of result:  
Example of result:  

<?xml version='1.0' encoding='UTF-8'?> <mailproapi version="1"> <Result>OK</Result> </mailproapi>

<mailproapi version="1"> <Result>OK</Result> </mailproapi>
<mailproapi version="1"> <Result>OK</Result> </mailproapi>
<mailproapi version="1"> <Result>OK</Result> </mailproapi>
<mailproapi version="1"> <Result>OK</Result> </mailproapi>
<mailproapi version="1"> <Result>OK</Result> </mailproapi>
<mailproapi version="1"> <Result>OK</Result> </mailproapi>
<mailproapi version="1"> <Result>OK</Result> </mailproapi>
<mailproapi version="1"> <Result>OK</Result> </mailproapi>
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
 
 
 
 
 
 
 
 
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
 
 
 
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>    
<mailproapi version="1"> <Result>OK</Result> </mailproapi>     8
<mailproapi version="1"> <Result>OK</Result> </mailproapi>     8
EDIT AN ADDRESSBOOK     EMAIL   Description: Edit an address Book Method: Post Call:
EDIT AN ADDRESSBOOK     EMAIL   Description: Edit an address Book Method: Post Call:

EDIT AN ADDRESSBOOK

EDIT AN ADDRESSBOOK     EMAIL   Description: Edit an address Book Method: Post Call:  
   
    EMAIL  
EMAIL
EMAIL

EMAIL

 

Description: Edit an address Book Method: Post

Call:

 
Description: Edit an address Book Method: Post Call:  
Description: Edit an address Book Method: Post Call:  
Description: Edit an address Book Method: Post Call:  

Base URL

 
https://api.mailpro.com/v2/addressbook/edit.xml
https://api.mailpro.com/v2/addressbook/edit.xml

https://api.mailpro.com/v2/addressbook/edit.xml

https://api.mailpro.com/v2/addressbook/edit.xml
Base URL   https://api.mailpro.com/v2/addressbook/edit.xml  
Base URL   https://api.mailpro.com/v2/addressbook/edit.xml  
Base URL   https://api.mailpro.com/v2/addressbook/edit.xml  
Base URL   https://api.mailpro.com/v2/addressbook/edit.xml  
 
 

Parameters

 

Name

 

Mandatory

 
Description

Description

  Name   Mandatory   Description  
  Name   Mandatory   Description  
  Name   Mandatory   Description  
 

IDClient

   

YES

This is a unique ID for identify the client
This is a unique ID for identify the client
This is a unique ID for identify the client

This is a unique ID for identify the client

This is a unique ID for identify the client
IDClient     YES This is a unique ID for identify the client
IDClient     YES This is a unique ID for identify the client
IDClient     YES This is a unique ID for identify the client
IDClient     YES This is a unique ID for identify the client

APIKey

   

YES

 
This is a GUID to identify the client and for access to the API
This is a GUID to identify the client and for access to the API
This is a GUID to identify the client and for access to the API
This is a GUID to identify the client and for access to the API
This is a GUID to identify the client and for access to the API

This is a GUID to identify the client and for access to the API

This is a GUID to identify the client and for access to the API
APIKey     YES   This is a GUID to identify the client and for access

AddressBookID

   

YES

 

ID of the address book

ID of the address book
ID of the address book
AddressBookID     YES   ID of the address book
AddressBookID     YES   ID of the address book
AddressBookID     YES   ID of the address book
AddressBookID     YES   ID of the address book

Title

   

YES

 
New title of address book
New title of address book

New title of address book

New title of address book
New title of address book
New title of address book
New title of address book
New title of address book
New title of address book
New title of address book
Title     YES   New title of address book  
Title     YES   New title of address book  
Title     YES   New title of address book  
Title     YES   New title of address book  
Title     YES   New title of address book  
Title     YES   New title of address book  
Title     YES   New title of address book  
 

Result attributes:

 
Result attributes:  
Result attributes:  
Result attributes:  
Result attributes:  
Result attributes:  
Result attributes:  
Result attributes:  
Result attributes:  
Result attributes:  
 

Name

 

Description

   

AddressBook[]

 
Identify the address book

Identify the address book

Identify the address book
Identify the address book
Identify the address book
AddressBook[]   Identify the address book
AddressBook[]   Identify the address book
AddressBook[]   Identify the address book
 

AddressBookId

 

ID of the address book

 

CreationDate

 
Creation date of this address book Format : YYYY-MM-DDThh:mm:ss (ISO format)
Creation date of this address book Format : YYYY-MM-DDThh:mm:ss (ISO format)
Creation date of this address book Format : YYYY-MM-DDThh:mm:ss (ISO format)
Creation date of this address book Format : YYYY-MM-DDThh:mm:ss (ISO format)
Creation date of this address book Format : YYYY-MM-DDThh:mm:ss (ISO format)

Creation date of this address book Format : YYYY-MM-DDThh:mm:ss (ISO format)

Creation date of this address book Format : YYYY-MM-DDThh:mm:ss (ISO format)
CreationDate   Creation date of this address book Format : YYYY-MM-DDThh:mm:ss (ISO format)
CreationDate   Creation date of this address book Format : YYYY-MM-DDThh:mm:ss (ISO format)
CreationDate   Creation date of this address book Format : YYYY-MM-DDThh:mm:ss (ISO format)
CreationDate   Creation date of this address book Format : YYYY-MM-DDThh:mm:ss (ISO format)

Title

Title of address book

Title of address book
Title of address book
Title of address book
Title Title of address book
Title Title of address book
Title Title of address book
Title Title of address book

Type

1

0

for Unsubscription address book

for Unsubscription address book for subscription address book

for subscription address book

for Unsubscription address book for subscription address book
for Unsubscription address book for subscription address book
for Unsubscription address book for subscription address book
Type 1 0 for Unsubscription address book for subscription address book
Type 1 0 for Unsubscription address book for subscription address book
Type 1 0 for Unsubscription address book for subscription address book
Type 1 0 for Unsubscription address book for subscription address book

NumberEmails

 

Number of email in this address book

 
 
 
 
 
 
 
 
 

Example of result:

<?xml version='1.0' encoding='UTF-8'?> <mailproapi version="1"> <AddressBook>

version='1.0' encoding='UTF-8'?> <mailproapi version="1"> <AddressBook>
version='1.0' encoding='UTF-8'?> <mailproapi version="1"> <AddressBook>
version='1.0' encoding='UTF-8'?> <mailproapi version="1"> <AddressBook>
version='1.0' encoding='UTF-8'?> <mailproapi version="1"> <AddressBook>
version='1.0' encoding='UTF-8'?> <mailproapi version="1"> <AddressBook>
version='1.0' encoding='UTF-8'?> <mailproapi version="1"> <AddressBook>
version="1"> <AddressBook>   <AddressBookID>1025</AddressBookID>
version="1"> <AddressBook>   <AddressBookID>1025</AddressBookID>
version="1"> <AddressBook>   <AddressBookID>1025</AddressBookID>
 

<AddressBookID>1025</AddressBookID>

 
  <AddressBookID>1025</AddressBookID>    
  <AddressBookID>1025</AddressBookID>    
 

<CreationDate>2012-01-02T01:00:00</CreationDate>

<Title>New Example</Title>

<Type>1</Type>

<Title>New Example</Title> <Type>1</Type>
<Title>New Example</Title> <Type>1</Type>

<NumberEmails>545</NumberEmails>

</AddressBook>

</mailproapi>

<NumberEmails>545</NumberEmails> </AddressBook> </mailproapi>
<NumberEmails>545</NumberEmails> </AddressBook> </mailproapi>
 
 
 
<NumberEmails>545</NumberEmails> </AddressBook> </mailproapi>    
<NumberEmails>545</NumberEmails> </AddressBook> </mailproapi>    
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
<NumberEmails>545</NumberEmails> </AddressBook> </mailproapi>     9
<NumberEmails>545</NumberEmails> </AddressBook> </mailproapi>     9
LIST EMAILS EMAIL   Description: Get a listing of all emails in an address book
LIST EMAILS EMAIL   Description: Get a listing of all emails in an address book

LIST EMAILS

LIST EMAILS EMAIL   Description: Get a listing of all emails in an address book Method:
EMAIL
EMAIL
EMAIL

EMAIL

 

Description: Get a listing of all emails in an address book Method: Get

Call:

Description: Get a listing of all emails in an address book Method: Get Call:
Description: Get a listing of all emails in an address book Method: Get Call:
Description: Get a listing of all emails in an address book Method: Get Call:

Base URL

 
https://api.mailpro.com/v2/email/list.xml

https://api.mailpro.com/v2/email/list.xml

https://api.mailpro.com/v2/email/list.xml
https://api.mailpro.com/v2/email/list.xml
https://api.mailpro.com/v2/email/list.xml
https://api.mailpro.com/v2/email/list.xml
https://api.mailpro.com/v2/email/list.xml
https://api.mailpro.com/v2/email/list.xml
 

Parameters

 

Name

 

Mandatory

Description

Description

Description
Description
Description
 

IdClient

YES

 
This is a unique ID for identify the client
This is a unique ID for identify the client
This is a unique ID for identify the client
This is a unique ID for identify the client

This is a unique ID for identify the client

This is a unique ID for identify the client
This is a unique ID for identify the client
This is a unique ID for identify the client
This is a unique ID for identify the client

ApiKey

 

YES

 
This is a GUID to identify the client and for access to the API
This is a GUID to identify the client and for access to the API
This is a GUID to identify the client and for access to the API
This is a GUID to identify the client and for access to the API
This is a GUID to identify the client and for access to the API
This is a GUID to identify the client and for access to the API

This is a GUID to identify the client and for access to the API

This is a GUID to identify the client and for access to the API
 

EmailFilter

 

NO

 
Text to filter the results

Text to filter the results

Text to filter the results
Text to filter the results
Text to filter the results
Text to filter the results
Text to filter the results
 

AddressBookId

 

NO

 
ID of the address book
ID of the address book

ID of the address book

ID of the address book
ID of the address book
ID of the address book
ID of the address book
ID of the address book
ID of the address book
 

NumberOfRecords

 

NO

 
By Default: 100 Items. If 0 return All. If PageNumber is used, it determines the
By Default: 100 Items. If 0 return All. If PageNumber is used, it determines the
By Default: 100 Items. If 0 return All. If PageNumber is used, it determines the
By Default: 100 Items. If 0 return All. If PageNumber is used, it determines the
By Default: 100 Items. If 0 return All. If PageNumber is used, it determines the
By Default: 100 Items. If 0 return All. If PageNumber is used, it determines the
By Default: 100 Items. If 0 return All. If PageNumber is used, it determines the

By Default: 100 Items. If 0 return All. If PageNumber is used, it determines the page size (number of records per page)

By Default: 100 Items. If 0 return All. If PageNumber is used, it determines the page
By Default: 100 Items. If 0 return All. If PageNumber is used, it determines the page
By Default: 100 Items. If 0 return All. If PageNumber is used, it determines the page
By Default: 100 Items. If 0 return All. If PageNumber is used, it determines the page
By Default: 100 Items. If 0 return All. If PageNumber is used, it determines the page
By Default: 100 Items. If 0 return All. If PageNumber is used, it determines the page
By Default: 100 Items. If 0 return All. If PageNumber is used, it determines the page
By Default: 100 Items. If 0 return All. If PageNumber is used, it determines the page
By Default: 100 Items. If 0 return All. If PageNumber is used, it determines the page
By Default: 100 Items. If 0 return All. If PageNumber is used, it determines the page

PageNumber

 

NO

 

Indicates the requested page number. It’s necessary to use with the parameter NumberOfRecords

Indicates the requested page number. It’s necessary to use with the parameter NumberOfRecords
Indicates the requested page number. It’s necessary to use with the parameter NumberOfRecords
Indicates the requested page number. It’s necessary to use with the parameter NumberOfRecords
Indicates the requested page number. It’s necessary to use with the parameter NumberOfRecords
Indicates the requested page number. It’s necessary to use with the parameter NumberOfRecords
Indicates the requested page number. It’s necessary to use with the parameter NumberOfRecords
Indicates the requested page number. It’s necessary to use with the parameter NumberOfRecords

SortByName

 

NO

 
Default false (and then sort by Creation Date Desc.)
Default false (and then sort by Creation Date Desc.)
Default false (and then sort by Creation Date Desc.)
Default false (and then sort by Creation Date Desc.)
Default false (and then sort by Creation Date Desc.)
Default false (and then sort by Creation Date Desc.)
Default false (and then sort by Creation Date Desc.)

Default false (and then sort by Creation Date Desc.)

Default false (and then sort by Creation Date Desc.)
Default false (and then sort by Creation Date Desc.)
Default false (and then sort by Creation Date Desc.)
 

Result attributes:

 
Result attributes:  
Result attributes:  
Result attributes:  
Result attributes:  
Result attributes:  
Result attributes:  
Result attributes:  
 

Name

 

Description

 

Emails[]

 

Contains list of Emails

Contains list of Emails
Contains list of Emails
Contains list of Emails
Contains list of Emails
Contains list of Emails
Contains list of Emails
Contains list of Emails
Contains list of Emails
 
 

Email

 

Identify each Emails

 
 

IdEmail

 

ID of the Email

  IdEmail   ID of the Email
  IdEmail   ID of the Email
  IdEmail   ID of the Email
  IdEmail   ID of the Email
  IdEmail   ID of the Email
  IdEmail   ID of the Email
  IdEmail   ID of the Email

IdAddressBook

 

ID of the Address Book

 
 
1 for Unsubscription address book, 0 for subscription address book
1 for Unsubscription address book, 0 for subscription address book
1 for Unsubscription address book, 0 for subscription address book
1 for Unsubscription address book, 0 for subscription address book

1 for Unsubscription address book, 0 for subscription address book

1 for Unsubscription address book, 0 for subscription address book
1 for Unsubscription address book, 0 for subscription address book
 

Field1

 

Field1

 

Field2

 

Field2

Field2   Field2
Field2   Field2
Field2   Field2

Field3

 

Field3

 

………

   
………    
………    

Field25

 

Field25

 
 
 
 
Field2 Field3   Field3   ………     Field25   Field25      
Field2 Field3   Field3   ………     Field25   Field25      
Field2 Field3   Field3   ………     Field25   Field25      
Field2 Field3   Field3   ………     Field25   Field25      
Field2 Field3   Field3   ………     Field25   Field25      
Field2 Field3   Field3   ………     Field25   Field25      
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
Field3   Field3   ………     Field25   Field25       10
Field3   Field3   ………     Field25   Field25       10
Example of result: <?xml version='1.0' encoding='UTF-8'?> <mailproapi
Example of result: <?xml version='1.0' encoding='UTF-8'?> <mailproapi

Example of result:

<?xml version='1.0' encoding='UTF-8'?> <mailproapi version="1">

 
result: <?xml version='1.0' encoding='UTF-8'?> <mailproapi version="1">  
result: <?xml version='1.0' encoding='UTF-8'?> <mailproapi version="1">  
result: <?xml version='1.0' encoding='UTF-8'?> <mailproapi version="1">  
result: <?xml version='1.0' encoding='UTF-8'?> <mailproapi version="1">  
result: <?xml version='1.0' encoding='UTF-8'?> <mailproapi version="1">  

<Emails> <Email>

 
<Emails> <Email>  
<Emails> <Email>  
<Emails> <Email>  
 

<IdEmail>1025</ IdEmail >

 
  <IdEmail>1025</ IdEmail >    
  <IdEmail>1025</ IdEmail >    
  <IdEmail>1025</ IdEmail >    
  <IdEmail>1025</ IdEmail >    
  <IdEmail>1025</ IdEmail >    
  <IdEmail>1025</ IdEmail >    
  <IdEmail>1025</ IdEmail >    
  <IdEmail>1025</ IdEmail >    
 

<

Email >test@test.com</ Email >

<field1>name</field1>

 
<field1>name</field1>      
 
<field1>name</field1>      
<field1>name</field1>      
<field1>name</field1>      
 
<field1>name</field1>      
<field1>name</field1>      

<field2>first name</field2>

<field25>street</field25>

<field25>street</field25>  
<field25>street</field25>  
<field25>street</field25>  
<field25>street</field25>  
<field25>street</field25>  
 
<field25>street</field25>  
<field25>street</field25>  
<field25>street</field25>  
<field25>street</field25>  
<field25>street</field25>  
<field25>street</field25>  
<field25>street</field25>  
<field25>street</field25>  
<field25>street</field25>  
<field25>street</field25>  
<field25>street</field25>  
<field25>street</field25>  
<field25>street</field25>  
<field25>street</field25>  
<field25>street</field25>  
<field25>street</field25>  
<field25>street</field25>  
<field25>street</field25>  
<field25>street</field25>  
<field25>street</field25>  
<field25>street</field25>  
<field25>street</field25>  
<field25>street</field25>  
<field25>street</field25>  
 

</Email>

 
  </Email>  

<Email>

 
<Email>  
 

<

IdEmail >78485</ IdEmail >

IdEmail >78485</ IdEmail >

     

<

Email >test2@test.com</ Email >

< Email >test2@test.com</ Email >
< Email >test2@test.com</ Email >
< Email >test2@test.com</ Email >
< Email >test2@test.com</ Email >
< Email >test2@test.com</ Email >
< Email >test2@test.com</ Email >

<field1>name</field1>

 

<field2>first name</field2>

<field25>street</field25>

<field2>first name</field2> <field25>street</field25>
<field2>first name</field2> <field25>street</field25>
<field2>first name</field2> <field25>street</field25>
<field2>first name</field2> <field25>street</field25>
<field2>first name</field2> <field25>street</field25>
 

</Email>

</Emails>

 
  </Email> </Emails>  
  </Email> </Emails>  

</mailproapi>

     
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
  </mailproapi>                      
  </mailproapi>                      
  </mailproapi>                      
  </mailproapi>                      
  </mailproapi>                      
  </mailproapi>                      
  </mailproapi>                      
  </mailproapi>                      
  </mailproapi>                      
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
  </mailproapi>                      
  </mailproapi>                      
  </mailproapi>                      
  </mailproapi>                      
  </mailproapi>                      
  </mailproapi>                      
  </mailproapi>                      
  </mailproapi>                      
  </mailproapi>                      
  </mailproapi>                      
  </mailproapi>                      
  </mailproapi>                      
  </mailproapi>                      
  </mailproapi>                      
  </mailproapi>                      
  </mailproapi>                      
  </mailproapi>                      
  </mailproapi>                      
  </mailproapi>                      
  </mailproapi>                      
  </mailproapi>                      
  </mailproapi>                      
  </mailproapi>                      
  </mailproapi>                      
  </mailproapi>                      
  </mailproapi>                      
  </mailproapi>                      
  </mailproapi>                       11
ADD SEVERAL EMAILS     EMAIL Description: Add one or more emails Method: Post Call:
ADD SEVERAL EMAILS     EMAIL Description: Add one or more emails Method: Post Call:

ADD SEVERAL EMAILS

ADD SEVERAL EMAILS     EMAIL Description: Add one or more emails Method: Post Call:  
   
    EMAIL
    EMAIL
EMAIL

EMAIL

Description: Add one or more emails Method: Post

Call:

 
Description: Add one or more emails Method: Post Call:  
Description: Add one or more emails Method: Post Call:  
Description: Add one or more emails Method: Post Call:  

Base URL

   

https://api.mailpro.com/v2/email/add.xml

https://api.mailpro.com/v2/email/add.xml
https://api.mailpro.com/v2/email/add.xml
Base URL     https://api.mailpro.com/v2/email/add.xml
Base URL     https://api.mailpro.com/v2/email/add.xml
Base URL     https://api.mailpro.com/v2/email/add.xml
Base URL     https://api.mailpro.com/v2/email/add.xml
Base URL     https://api.mailpro.com/v2/email/add.xml
 

Parameters

 

Name

 

Mandatory

 
Description

Description

Name   Mandatory   Description
Name   Mandatory   Description
Name   Mandatory   Description

IdClient

 

YES

This is a unique ID for identify the client
This is a unique ID for identify the client
This is a unique ID for identify the client

This is a unique ID for identify the client

IdClient   YES This is a unique ID for identify the client
IdClient   YES This is a unique ID for identify the client
IdClient   YES This is a unique ID for identify the client
IdClient   YES This is a unique ID for identify the client
IdClient   YES This is a unique ID for identify the client

ApiKey

 

YES

This is a GUID to identify the client and for access to the API
This is a GUID to identify the client and for access to the API
This is a GUID to identify the client and for access to the API
This is a GUID to identify the client and for access to the API

This is a GUID to identify the client and for access to the API

This is a GUID to identify the client and for access to the API
ApiKey   YES This is a GUID to identify the client and for access to the
ApiKey   YES This is a GUID to identify the client and for access to the

AddressBookId

 

YES

ID of the address book

ID of the address book
AddressBookId   YES ID of the address book
AddressBookId   YES ID of the address book
AddressBookId   YES ID of the address book
AddressBookId   YES ID of the address book
AddressBookId   YES ID of the address book

EmailList

   

YES

(CRLF) (CRLF) Email with following format : email,field1,field2, email2,field1,field2, ,field25 ,field25 Fields 1 to 25
(CRLF) (CRLF) Email with following format : email,field1,field2, email2,field1,field2, ,field25 ,field25 Fields 1 to 25
(CRLF) (CRLF) Email with following format : email,field1,field2, email2,field1,field2, ,field25 ,field25 Fields 1 to 25

(CRLF)

(CRLF)

Email with following format :

email,field1,field2,

(CRLF) Email with following format : email,field1,field2, email2,field1,field2, ,field25 ,field25 Fields 1 to 25 are

email2,field1,field2,

,field25

with following format : email,field1,field2, email2,field1,field2, ,field25 ,field25 Fields 1 to 25 are not mandatory

,field25

Fields 1 to 25 are not mandatory

with following format : email,field1,field2, email2,field1,field2, ,field25 ,field25 Fields 1 to 25 are not mandatory
with following format : email,field1,field2, email2,field1,field2, ,field25 ,field25 Fields 1 to 25 are not mandatory
following format : email,field1,field2, email2,field1,field2, ,field25 ,field25 Fields 1 to 25 are not mandatory
following format : email,field1,field2, email2,field1,field2, ,field25 ,field25 Fields 1 to 25 are not mandatory
following format : email,field1,field2, email2,field1,field2, ,field25 ,field25 Fields 1 to 25 are not mandatory
following format : email,field1,field2, email2,field1,field2, ,field25 ,field25 Fields 1 to 25 are not mandatory
following format : email,field1,field2, email2,field1,field2, ,field25 ,field25 Fields 1 to 25 are not mandatory
following format : email,field1,field2, email2,field1,field2, ,field25 ,field25 Fields 1 to 25 are not mandatory
following format : email,field1,field2, email2,field1,field2, ,field25 ,field25 Fields 1 to 25 are not mandatory
following format : email,field1,field2, email2,field1,field2, ,field25 ,field25 Fields 1 to 25 are not mandatory
following format : email,field1,field2, email2,field1,field2, ,field25 ,field25 Fields 1 to 25 are not mandatory

Force

 

NO

bypass all check (duplicates, etc 1 Check duplicates and update Default value 1 2 ).
bypass all check (duplicates, etc 1 Check duplicates and update Default value 1 2 ).
bypass all check (duplicates, etc 1 Check duplicates and update Default value 1 2 ).

bypass all check (duplicates, etc

1

Check duplicates and update Default value 1

2

bypass all check (duplicates, etc 1 Check duplicates and update Default value 1 2 ).
bypass all check (duplicates, etc 1 Check duplicates and update Default value 1 2 ).
).
).
bypass all check (duplicates, etc 1 Check duplicates and update Default value 1 2 ).
bypass all check (duplicates, etc 1 Check duplicates and update Default value 1 2 ).
Force   NO bypass all check (duplicates, etc 1 Check duplicates and update Default value 1
Force   NO bypass all check (duplicates, etc 1 Check duplicates and update Default value 1
Force   NO bypass all check (duplicates, etc 1 Check duplicates and update Default value 1
Force   NO bypass all check (duplicates, etc 1 Check duplicates and update Default value 1
Force   NO bypass all check (duplicates, etc 1 Check duplicates and update Default value 1
Force   NO bypass all check (duplicates, etc 1 Check duplicates and update Default value 1
Force   NO bypass all check (duplicates, etc 1 Check duplicates and update Default value 1
Force   NO bypass all check (duplicates, etc 1 Check duplicates and update Default value 1

Result attributes:

 
Result attributes:  
Result attributes:  
Result attributes:  
Result attributes:  
Result attributes:  
Result attributes:  
Result attributes:  
Result attributes:  
Result attributes:  
Result attributes:  
 

Name

   

Description

NumberEmail

 
Number of emails inserted

Number of emails inserted

Number of emails inserted
Number of emails inserted
 
NumberEmail   Number of emails inserted  
NumberEmail   Number of emails inserted  
NumberEmail   Number of emails inserted  
NumberEmail   Number of emails inserted  

EmailUpdated

 

If Force parameter is 2: number of emails updated

 
 
 
 
 
 
 
 
 
 

Example of result:

<?xml version='1.0' encoding='UTF-8'?> <mailproapi version="1">

<

NumberEmail >2569</ NumberEmail >

<mailproapi version="1"> < NumberEmail >2569</ NumberEmail >
<mailproapi version="1"> < NumberEmail >2569</ NumberEmail >
<mailproapi version="1"> < NumberEmail >2569</ NumberEmail >
<mailproapi version="1"> < NumberEmail >2569</ NumberEmail >
<mailproapi version="1"> < NumberEmail >2569</ NumberEmail >
<mailproapi version="1"> < NumberEmail >2569</ NumberEmail >
<mailproapi version="1"> < NumberEmail >2569</ NumberEmail >
<mailproapi version="1"> < NumberEmail >2569</ NumberEmail >
<mailproapi version="1"> < NumberEmail >2569</ NumberEmail >
<mailproapi version="1"> < NumberEmail >2569</ NumberEmail >
<mailproapi version="1"> < NumberEmail >2569</ NumberEmail >
<mailproapi version="1"> < NumberEmail >2569</ NumberEmail >
<mailproapi version="1"> < NumberEmail >2569</ NumberEmail >

EmailUpdated >458</ EmailUpdated > </mailproapi>

<

EmailUpdated >458</ EmailUpdated > </mailproapi> <
EmailUpdated >458</ EmailUpdated > </mailproapi> <
EmailUpdated >458</ EmailUpdated > </mailproapi> <
 
 
 
>2569</ NumberEmail > EmailUpdated >458</ EmailUpdated > </mailproapi> <  
>2569</ NumberEmail > EmailUpdated >458</ EmailUpdated > </mailproapi> <  
>2569</ NumberEmail > EmailUpdated >458</ EmailUpdated > </mailproapi> <  
>2569</ NumberEmail > EmailUpdated >458</ EmailUpdated > </mailproapi> <  
>2569</ NumberEmail > EmailUpdated >458</ EmailUpdated > </mailproapi> <  
>2569</ NumberEmail > EmailUpdated >458</ EmailUpdated > </mailproapi> <  
>2569</ NumberEmail > EmailUpdated >458</ EmailUpdated > </mailproapi> <  
>2569</ NumberEmail > EmailUpdated >458</ EmailUpdated > </mailproapi> <  
>2569</ NumberEmail > EmailUpdated >458</ EmailUpdated > </mailproapi> <  
>2569</ NumberEmail > EmailUpdated >458</ EmailUpdated > </mailproapi> <  
>2569</ NumberEmail > EmailUpdated >458</ EmailUpdated > </mailproapi> <  
>2569</ NumberEmail > EmailUpdated >458</ EmailUpdated > </mailproapi> <  
>2569</ NumberEmail > EmailUpdated >458</ EmailUpdated > </mailproapi> <  
>2569</ NumberEmail > EmailUpdated >458</ EmailUpdated > </mailproapi> <  
>2569</ NumberEmail > EmailUpdated >458</ EmailUpdated > </mailproapi> <  
>2569</ NumberEmail > EmailUpdated >458</ EmailUpdated > </mailproapi> <  
>2569</ NumberEmail > EmailUpdated >458</ EmailUpdated > </mailproapi> <  
>2569</ NumberEmail > EmailUpdated >458</ EmailUpdated > </mailproapi> <  
>2569</ NumberEmail > EmailUpdated >458</ EmailUpdated > </mailproapi> <  
>2569</ NumberEmail > EmailUpdated >458</ EmailUpdated > </mailproapi> <  
>2569</ NumberEmail > EmailUpdated >458</ EmailUpdated > </mailproapi> <  
>2569</ NumberEmail > EmailUpdated >458</ EmailUpdated > </mailproapi> <  
>2569</ NumberEmail > EmailUpdated >458</ EmailUpdated > </mailproapi> <  
>2569</ NumberEmail > EmailUpdated >458</ EmailUpdated > </mailproapi> <  
NumberEmail > EmailUpdated >458</ EmailUpdated > </mailproapi> <   12
NumberEmail > EmailUpdated >458</ EmailUpdated > </mailproapi> <   12
ADD SINGLE EMAIL     EMAIL Description: Add one email Method: Post Call:   Base
ADD SINGLE EMAIL     EMAIL Description: Add one email Method: Post Call:   Base

ADD SINGLE EMAIL

ADD SINGLE EMAIL     EMAIL Description: Add one email Method: Post Call:   Base URL
   
    EMAIL
    EMAIL
EMAIL

EMAIL

Description: Add one email Method: Post

Call:

 
Description: Add one email Method: Post Call:  
Description: Add one email Method: Post Call:  
Description: Add one email Method: Post Call:  

Base URL

   
https://api.mailpro.com/v2/email/addSingle.xml

https://api.mailpro.com/v2/email/addSingle.xml

https://api.mailpro.com/v2/email/addSingle.xml
Base URL     https://api.mailpro.com/v2/email/addSingle.xml
Base URL     https://api.mailpro.com/v2/email/addSingle.xml
Base URL     https://api.mailpro.com/v2/email/addSingle.xml
Base URL     https://api.mailpro.com/v2/email/addSingle.xml
Base URL     https://api.mailpro.com/v2/email/addSingle.xml
 

Parameters

 

Name

 

Mandatory

Description

Description

Name   Mandatory Description
Name   Mandatory Description
Name   Mandatory Description

IdClient

 

YES

This is a unique ID for identify the client
This is a unique ID for identify the client
This is a unique ID for identify the client

This is a unique ID for identify the client

IdClient   YES This is a unique ID for identify the client
IdClient   YES This is a unique ID for identify the client
IdClient   YES This is a unique ID for identify the client
IdClient   YES This is a unique ID for identify the client
IdClient   YES This is a unique ID for identify the client

ApiKey

 

YES

This is a GUID to identify the client and for access to the API
This is a GUID to identify the client and for access to the API
This is a GUID to identify the client and for access to the API
This is a GUID to identify the client and for access to the API

This is a GUID to identify the client and for access to the API

This is a GUID to identify the client and for access to the API
ApiKey   YES This is a GUID to identify the client and for access to the
ApiKey   YES This is a GUID to identify the client and for access to the

AddressBookId

 

YES

ID of the address book

ID of the address book
AddressBookId   YES ID of the address book
AddressBookId   YES ID of the address book
AddressBookId   YES ID of the address book
AddressBookId   YES ID of the address book
AddressBookId   YES ID of the address book

Email

 

YES

Email address

Email address
Email address
Email address
Email address
Email   YES Email address
Email   YES Email address
Email   YES Email address
Email   YES Email address

Field1

 

NO

Additional info

Additional info

Additional info
Additional info
Field1   NO Additional info
Field1   NO Additional info
Field1   NO Additional info
Field1   NO Additional info
Field1   NO Additional info

Field2

 

NO

Additional info

Field3

 

NO

Additional info
Additional info

Additional info

Additional info
Additional info
Additional info
Field3   NO Additional info
Field3   NO Additional info
Field3   NO Additional info
Field3   NO Additional info
   

NO

Additional info

Additional info

Additional info
Additional info
    NO Additional info
    NO Additional info
    NO Additional info
    NO Additional info

Field25

   

NO

Additional info

     

1

1 bypass all check (duplicates, etc ).
1 bypass all check (duplicates, etc ).
1 bypass all check (duplicates, etc ).

bypass all check (duplicates, etc

).
).
1 bypass all check (duplicates, etc ).
      1 bypass all check (duplicates, etc ).
      1 bypass all check (duplicates, etc ).
      1 bypass all check (duplicates, etc ).
      1 bypass all check (duplicates, etc ).
      1 bypass all check (duplicates, etc ).

Force

NO

Check duplicates and update Default value 1

2

Check duplicates and update Default value 1 2
Check duplicates and update Default value 1 2
Check duplicates and update Default value 1 2
Force NO Check duplicates and update Default value 1 2
Force NO Check duplicates and update Default value 1 2
Force NO Check duplicates and update Default value 1 2
Force NO Check duplicates and update Default value 1 2

Result attributes:

 
Result attributes:  
Result attributes:  
Result attributes:  
Result attributes:  
Result attributes:  
Result attributes:  
Result attributes:  
Result attributes:  
 

Name

   

Description

NumberEmail

 

Number of emails inserted

Number of emails inserted
Number of emails inserted
NumberEmail   Number of emails inserted
NumberEmail   Number of emails inserted
NumberEmail   Number of emails inserted
NumberEmail   Number of emails inserted
NumberEmail   Number of emails inserted

EmailUpdated

If Force parameter is 2: number of emails updated

 

Example of result:

 
Example of result:  
Example of result:  
Example of result:  
Example of result:  
Example of result:  
Example of result:  

<?xml version='1.0' encoding='UTF-8'?> <mailproapi version="1">

<

NumberEmail >2569</ NumberEmail >

<mailproapi version="1"> < NumberEmail >2569</ NumberEmail >
<mailproapi version="1"> < NumberEmail >2569</ NumberEmail >
<mailproapi version="1"> < NumberEmail >2569</ NumberEmail >
<mailproapi version="1"> < NumberEmail >2569</ NumberEmail >
<mailproapi version="1"> < NumberEmail >2569</ NumberEmail >

EmailUpdated >458</ EmailUpdated > </mailproapi>

<

>2569</ NumberEmail > EmailUpdated >458</ EmailUpdated > </mailproapi> <  
>2569</ NumberEmail > EmailUpdated >458</ EmailUpdated > </mailproapi> <  
 
 
 
>2569</ NumberEmail > EmailUpdated >458</ EmailUpdated > </mailproapi> <  
>2569</ NumberEmail > EmailUpdated >458</ EmailUpdated > </mailproapi> <  
>2569</ NumberEmail > EmailUpdated >458</ EmailUpdated > </mailproapi> <  
>2569</ NumberEmail > EmailUpdated >458</ EmailUpdated > </mailproapi> <  
>2569</ NumberEmail > EmailUpdated >458</ EmailUpdated > </mailproapi> <  
>2569</ NumberEmail > EmailUpdated >458</ EmailUpdated > </mailproapi> <  
>2569</ NumberEmail > EmailUpdated >458</ EmailUpdated > </mailproapi> <  
>2569</ NumberEmail > EmailUpdated >458</ EmailUpdated > </mailproapi> <  
>2569</ NumberEmail > EmailUpdated >458</ EmailUpdated > </mailproapi> <  
>2569</ NumberEmail > EmailUpdated >458</ EmailUpdated > </mailproapi> <  
>2569</ NumberEmail > EmailUpdated >458</ EmailUpdated > </mailproapi> <  
>2569</ NumberEmail > EmailUpdated >458</ EmailUpdated > </mailproapi> <  
>2569</ NumberEmail > EmailUpdated >458</ EmailUpdated > </mailproapi> <  
>2569</ NumberEmail > EmailUpdated >458</ EmailUpdated > </mailproapi> <  
>2569</ NumberEmail > EmailUpdated >458</ EmailUpdated > </mailproapi> <  
>2569</ NumberEmail > EmailUpdated >458</ EmailUpdated > </mailproapi> <