This page provides you information about how to use MailUp REST API to create email messages and to send them to specified recipients.
...
| Description | Retrieve email messages of specified list |
|---|
HTTP Method | GET |
|---|
URL | Retrieve all email messages of that list | Code Block |
|---|
GET https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Emails |
Retrieve only email messages that have been published (i.e. with public visibility, see details) 1 | Code Block |
|---|
GET https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Online/Emails |
Retrieve only email messages that have been archived (see details) 1 | Code Block |
|---|
GET https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Archived/Emails |
Note: 1 an empty list is returned if public visibility of messages (aka Web library) is disabled. You shall enable it to Retrieve them |
|---|
JSON request (example) | none |
|---|
JSON response (example) | All email messages of specified list | Expand |
|---|
| Code Block |
|---|
{
"IsPaginated":false,
"Items":[
{
"CreationDate": "2017-05-29 08:21:59Z",
"Notes": "Issue n. 5",
"Subject": "Monthly Newsletter 4",
"idList": 1,
"idMessage": 38,
"ServiceType": 0
},
{
"CreationDate": "2017-05-24 13:05:08Z",
"Notes": "notes",
"Subject": "La prova",
"idList": 1,
"idMessage": 37,
"ServiceType": 0
}
],
"PageNumber":0,
"PageSize":20,
"Skipped":0,
"TotalElementsCount":2
} |
|
| Expand |
|---|
| title | About ServiceType field... |
|---|
| ServiceType field shows the message types. Here the most common values: | Value | Description |
|---|
| 0 | Newsletter | | 1 | SMTP+ |
P.S.: the ServiceType field has a value greater than 1 when your platform has a custom configuration. Please contact us, if you need more information. |
List published messages (public URLs are also provided) | Expand |
|---|
"LastSendDate":"0001-01-01 00:00:00Z" is returned when message has never been sent | Code Block |
|---|
{
"IsPaginated":false,
"Items":[
{
"Subject":"Monthly Newsletter 4",
"idList":2,
"idMessage":62,
"CreationDate":"2014-05-21 12:14:41Z",
"LastSendDate":"0001-01-01 00:00:00Z",
"Notes":"Issue n. 5",
"Url":"http:\/\/d0i4e.s57.it\/frontend\/nl_preview_window.aspx?idNL=62"
}
],
"PageNumber":0,
"PageSize":20,
"Skipped":0,
"TotalElementsCount":1
} |
|
List archived messages | Expand |
|---|
| Code Block |
|---|
{
"IsPaginated":false,
"Items":[
{
"Subject":"Annual Newsletter n.13",
"idList":2,
"idMessage":27,
"CreationDate":"2014-05-22 09:37:56Z",
"LastSendDate":"",
"Notes":"Issue n. 10 June 2014",
"Url":"http:\/\/d0i4f.s57.it\/frontend\/nl_preview_window.aspx?idNL=27"
},
{
"Subject":"Annual Newsletter n.4",
"idList":2,
"idMessage":26,
"CreationDate":"2014-05-22 08:55:15Z",
"LastSendDate":"",
"Notes":"Issue n. 6 June 2014",
"Url":"http:\/\/d0i4f.s57.it\/frontend\/nl_preview_window.aspx?idNL=26"
}
],
"PageNumber":0,
"PageSize":20,
"Skipped":0,
"TotalElementsCount":2
} |
|
|
|---|
Paging and filtering (example) | 2 items per page, get first page (count starts from zero): - https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/2/Emails?PageNumber=0&PageSize=2
Retrieve messages that contain the word "test" in the subject field and order by ID. Note: search by text is case sensitive: - https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/2/Emails?filterby="Subject.Contains(%27test%27)"&orderby="idMessage+asc"
Retrieve only the messages with tags whose IDs are 1, 13 or 45 (at least one of them): - https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/2/Emails?tags="1,13,45"
Retrieve only the messages with tags whose ID is 13 or names are customers, welcome message or hello, world (at least one of them): - https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/2/Emails?tags="13,customers,welcome message,'hello, world'"
Retrieve only the newsletter messages: - https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/2/Emails?filterby="servicetype==0"
Retrieve only the SMTP+ messages: - https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/2/Emails?filterby="servicetype==1"
|
|---|
...
Description | Copy an existing message |
|---|
HTTP Method | POST |
|---|
URL | | Code Block |
|---|
| https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/list/{id_List}/Email/{id_Message} |
|
|---|
JSON request (example) | Copy message as is: | Code Block |
|---|
POST https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/list/2/Email/135 |
Copy message modifying Notes: | Code Block |
|---|
POST https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/list/2/Email/135
{"Notes": "This is a new note!!!"} |
|
|---|
JSON response (example) | | Code Block |
|---|
{
"CreationDate": "2017-08-30 15:24:07Z",
"Notes": "This is a new note!!!",
"Subject": "Important email",
"idList": 1,
"idMessage": 136
} |
|
|---|
Paging and filtering (example) | |
|---|
Manage message online visibility
Description | Publish an existing message |
|---|
HTTP Method | PUT |
|---|
URL | | Code Block |
|---|
| https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/list/{id_List}/Email/{id_Message}/OnlineVisibility |
|
|---|
JSON request (example) | Puslish a message: | Code Block |
|---|
PUT https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/list/2/Email/135/OnlineVisibility
true |
Unpuslish a message: | Code Block |
|---|
PUT https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/list/2/Email/135/OnlineVisibility
false |
|
|---|
JSON response (example) | None |
|---|
Paging and filtering (example) | |
|---|
...
Send Email Messages
This section contains methods to send messages and to retrieve the history of sent messages.
...