This page provides you information about how to use MailUp REST API to create email messages and to send them to specified recipients.
On this page:
| Toc |
|---|
Opens
An email message is always created inside the environment of a MailUp list, so it cannot be managed outside of that list.
Create a message
Description |
| ||
|---|---|---|---|
HTTP Method | POST | ||
URL |
| ||
JSON request (example) |
| ||
JSON response (example) |
| ||
Paging and filtering (example) |
|
List Messages
| Description | |||||
|---|---|---|---|---|---|
HTTP Method | GET | ||||
URL | Retreive all email messages of that list
Retreive only email messages that have been published (i.e. with public visibility, see details)
| ||||
JSON request (example) | none | ||||
JSON response (example) |
| ||||
Paging and filtering (example) | 2 items per page, get first page (count starts from zero)
Retreive messages that contain the word "test" in the subject field and order by ID. Note: search by text is case sensitive
|
Read message details
...
HTTP Method
...
GET
...
URL
...
get email statistics by message and by recipient.
| Info | ||
|---|---|---|
| ||
Email Statistics use a different "base URL" than methods that can be used to manage your console account resources. Caller application should handle three distinct base URL when working with REST API ("Console", "Statistics" and "Public") Use of paging for email statistics is strongly recommended because in some cases the size of returned data could be really big (i.e. caller applications may experience either response time that are longer than expected or errors that are related to maximum data size restrictions on the infrastructure that hosts the caller). By implementing paging, a developer is able to test the caller application in its edge cases, in such a way that even huge number of opens, delivered emails or clicks do not represent a problem. |
On this page:
| Toc |
|---|
...
Get Statistics by Message
This section enables you to get statistics of an email message by specifying its ID. You can get message IDs by using List Messages method. For each type of statistics by message both a "COUNT" method (only the total number) and a "LIST" method (all available details) are provided.
If you reuse a specified message and perform more sendings with it you should be aware that message statistics of a specific sending cannot be handled separately from the statistics of the other sendings of the same message. If you need to separate the statistics of each sending it is recommended that you clone (i.e. make a copy of the message) whenever you are planning a new campaign.
Read message recipients
Please note that message recipients are kept inside MailUp only for 15 days, after that period COUNT returns zero and LIST returns an empty array.
Description | Get recipients that received the specified message | |||||
|---|---|---|---|---|---|---|
HTTP Method | GET | |||||
URL | Get the number of recipients that received the specified message (COUNT)
Get attachment list for the specified message ida list of email addresses that received specified message (LIST, pagination is set as default with pageSize=20)
| |||||
JSON request (example) | none | |||||
JSON response (example) |
...
Paging and filtering (example)
Manage email attachments
...
HTTP Method
...
GET
...
URL
...
...
JSON request (example)
...
none
...
JSON response (example)
...
...
Paging and filtering (example)
Send Email Messages
Send to all subscribers
...
HTTP Method
...
POST
...
URL
...
...
JSON request (example)
...
none
...
JSON response (example)
...
...
Paging and filtering (example)
Send to a group
...
HTTP Method
...
POST
...
URL
...
...
JSON request (example)
...
none
...
JSON response (example)
...
...
Paging and filtering (example)
Send to a recipient
...
HTTP Method
...
POST
...
URL
...
...
JSON request (example)
...
none
...
JSON response (example)
...
...
Paging and filtering (example)
Retreive sending history
An email message can be sent several times. This feature allows to retreive details about each sending.
| Description | |||||
|---|---|---|---|---|---|
HTTP Method | GET | ||||
URL | /Console/List/{id_List}/Email/{id_Message}/SendHistory | ||||
JSON request (example) | none | ||||
JSON response (example) | COUNT method simply return the number of delivered messages (e.g. 103) LIST method returns a paged list
| ||||
Paging and filtering (example) | 2 items per page, get first page (count starts from zero)
Retreive messages that contain the word "test" in the subject field and order by ID. Note: search by text is case sensitive
|
Update message
| Description | |
|---|---|
HTTP Method | GET |
URL |
|
JSON request (example) | none |
JSON response (example) |
|
Paging and filtering (example) |
|
Manage tags
...
HTTP Method
...
GET
...
URL
...
...
JSON request (example)
...
none
...
JSON response (example)
...
| ||||
Paging and filtering (example) | N/A
|
|---|