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 | Send a message to all list subscribers |
---|
HTTP Method | POST |
---|
URL | Use the default list sender Code Block |
---|
POST https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Email/{id_Message}/Send |
Use the sender that is provided by querystring parameters Code Block |
---|
POST https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Email/{id_Message}/Send?SenderName="{name}"&SenderAddress="{email}" |
|
---|
JSON request (example) | none |
---|
JSON response (example) | See notes at the bottom of this page1 Code Block |
---|
{"Id":2147483647,"InvalidRecipients":[],"Sent":7,"UnprocessedRecipients":[],"idMessage":24} |
|
---|
Paging and filtering (example) | none |
---|
Send to list
...
recipients filtering by groups
Description | Send a message to list subscribers filtering by groups. The method allows subscribers inclusion and exclusion by groups. The method applies this logic: - include subscribers by groups defined by inGroups querystring parameters;
- exclude subscribers by groups defined by notInGroups querystring parameters.
The method checks if the selected list contains the provided groupsYou may need to restrict your mailing to those recipients that belong to some MailUp groups or you may need to exclude the recipients of some groups. When using specific querystring parameters with a valid value, the Send method allows including or excluding the recipients that belong to a list of specified groups. Here is how it works: - use the inGroups querystring parameter to set the IDs of the MailUp groups to be included (i.e. all the group members will be added)
- use the notInGroups querystring parameter to set the IDs of the MailUp groups to be excluded;
Please note that all the parameters' values must correspond to groups that belong to the MailUp list {id_List} specified in the REST endpoint. |
---|
HTTP Method | POST |
---|
URL | Inclusion Include subscribers by recipients that belong to one or more groups. It is mandatory that the list contains at least one of provided groups belongs to the specified MailUp list, otherwise the method return returns a 500 error. If a subscriber appairs in more then In case of empty values, the inGroups parameter is ignored and the message is sent to all the MailUp list recipients If a recipients belongs to more than one group, it will be taken only added just one time. Code Block |
---|
POST https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Email/{id_Message}/Send?inGroups=12
POST https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Email/{id_Message}/Send?inGroups=12,23,45 |
Exclusion Exclude subscribers by that belong to one or more groups. If the specified MailUp list does not contain all the provided groups, the method does not exclude any subscribers recipient and it sends the newsletter to all the MailUp list subscribersrecipients. Code Block |
---|
POST https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Email/{id_Message}/Send?notInGroups=12
POST https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Email/{id_Message}/Send?notInGroups=12,23,45 |
Inclusion and exclusionInclude and exclude subscribers by one or more groups. It is mandatory that the list contains This is a case of that merges the cases seen above: both inGroups and notInGroups are used. inGroups: it is mandatory that at least one of groups defined by inGroups querystring parameter, otherwise the method return a 500 error. The method exclude subscribers by groups if list contains at least one group from notInGroups querystring parameter, otherwise the provided groups belongs to the specified MailUp list. Otherwise the method returns a 500 error. In case of empty values, the inGroups parameter is ignored and the message is sent to all the MailUp list recipients. notInGroups: if the specified MailUp list does not contain all the provided groups, the method does not exclude any subscribers recipient and sends the newsletter to all subscribers contained in groups defined by inGroups querystring the recipients filtered by the inGroups parameter. Code Block |
---|
POST https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Email/{id_Message}/Send?inGroups=12¬InGroups=89,90
POST https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Email/{id_Message}/Send?inGroups=12,23,45¬InGroups=89 |
|
---|
JSON request (example) | none |
---|
JSON response (example) | See notes at the bottom of this page1 Code Block |
---|
{"Id":2147483647,"InvalidRecipients":[],"Sent":7,"UnprocessedRecipients":[],"idMessage":24} |
|
---|
Paging and filtering (example) | none
|
---|
...