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:

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	https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Email
JSON request (example)	Click here to expand...
JSON response (example)
Paging and filtering (example)

List Messages

Description
HTTP Method	GET
URL	Retreive all email messages of that list https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Emails Retreive only email messages that have been published (i.e. with public visibility, see details) https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Online/Emails
JSON request (example)	none
JSON response (example)	Click here to expand... {"IsPaginated":false,"Items":[{"Subject":"test","idList":2,"idMessage":29},{"Subject":"Explore the new feature of List Plus","idList":2,"idMessage":28},{"Subject":"Testing List Plus","idList":2,"idMessage":27},{"Subject":"Triggered news from MailUp Blog","idList":2,"idMessage":8}],"PageNumber":0,"PageSize":20,"Skipped":0,"TotalElementsCount":4}
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 Retreive 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"

Read message details

Description
HTTP Method	GET
URL	Retrieve the email details by specified id https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Email/{id_Message} Get attachment list for the specified message id https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Email/{id_Message}/Attachment
JSON request (example)	none
JSON response (example)	Click here to expand... {"Subject":"Monthly Newsletter","idList":2,"idMessage":24,"Content":" <table><tbody><tr><td><strong>Image</strong> </td><td><strong>Text</strong> </td></tr><tr><td style="width: 200px; height: 70px;"> <img src="http://d0i4f.s57.it/images/2/ListImages/sociallogin.PNG" alt="This text is visible if you do not see images" title="SocialLogin" longdesc="Social Login Image" width="200" height="70"></td><td> This screenshot shows you how to perform login with social networks<br> (see <a href="http://[track]/https://help.mailup.com" target="_blank" id="User" s="" manual'="">manual</a>) </td></tr></tbody></table> ","Embed":false,"Fields":[{"Description":"FirstName","Id":1,"Value":""},{"Description":"LastName","Id":2,"Value":""},{"Description":"Company","Id":3,"Value":""},{"Description":"City","Id":4,"Value":""},{"Description":"Province","Id":5,"Value":""},{"Description":"ZIP","Id":6,"Value":""},{"Description":"State","Id":7,"Value":""},{"Description":"Region","Id":8,"Value":""},{"Description":"Address","Id":9,"Value":""},{"Description":"Gender ","Id":10,"Value":""},{"Description":"phone","Id":11,"Value":""},{"Description":"CustomerID","Id":12,"Value":""},{"Description":"LatestOrderID","Id":13,"Value":""},{"Description":"LatestOrderDate","Id":14,"Value":""},{"Description":"LatestOrderAmount","Id":15,"Value":""},{"Description":"LatestOrderProductIDs","Id":16,"Value":""},{"Description":"LatestOrderCategoryIDs","Id":17,"Value":""},{"Description":"LatestShippedOrderDate","Id":18,"Value":""},{"Description":"LatestShippedOrderID","Id":19,"Value":""},{"Description":"LatestAbandonedCartDate","Id":20,"Value":""},{"Description":"LatestAbandonedCartTotal","Id":21,"Value":""},{"Description":"LatestAbandonedCartID","Id":22,"Value":""},{"Description":"TotalOrdered","Id":23,"Value":""},{"Description":"TotalOrderedLast12m","Id":24,"Value":""},{"Description":"TotalOrderedLast30d","Id":25,"Value":""},{"Description":"AllOrderedProductIDs","Id":26,"Value":""},{"Description":"WantsBlogUpdate","Id":27,"Value":""}],"IsConfirmation":false,"Notes":"Issue n. 5 May 2014","Tags":[{"Enabled":false,"Id":5,"Name":"news"},{"Enabled":false,"Id":4,"Name":"users-manual"}],"TrackingInfo":{"CustomParams":"","Enabled":true,"Protocols":["http:","https:","ftp:","news:"]},"Attachments":[{"Name":"24\/jp.txt","Path":"http:\/\/d0i4f.s57.it\\d0i4f\\download\\24\\24\/jp.txt","Slot":1}]}
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 Retreive 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"

Update message

Description
HTTP Method	GET
URL
JSON request (example)	none
JSON response (example)
Paging and filtering (example)

Manage tags

Description
HTTP Method	GET
URL
JSON request (example)	none
JSON response (example)
Paging and filtering (example)

Manage email attachments

Description
HTTP Method	GET
URL
JSON request (example)	none
JSON response (example)
Paging and filtering (example)

Send Email Messages

Send to all subscribers

Description
HTTP Method	POST
URL
JSON request (example)	none
JSON response (example)
Paging and filtering (example)

Send to a group

Description
HTTP Method	POST
URL
JSON request (example)	none
JSON response (example)
Paging and filtering (example)

Send to a recipient

Description
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)	Click here to expand... An email message has been sent three times with different senders, here below the results {"IsPaginated":false,"Items":[{"EndDate":"2014-04-01 13:53:06Z","Kb_transferred":6302,"Recipients":1,"SenderEmail":"marketing@example.com","SenderName":"Your Dealer","StartDate":"2014-04-01 13:52:35Z","idMessage":12},{"EndDate":"2014-04-01 13:54:32Z","Kb_transferred":12604,"Recipients":2,"SenderEmail":"brown@example.com","SenderName":"Mike Brown","StartDate":"2014-04-01 13:53:57Z","idMessage":12},{"EndDate":"2014-04-06 13:48:33Z","Kb_transferred":12604,"Recipients":2,"SenderEmail":"sales@example.com","SenderName":"Sales","StartDate":"2014-04-06 13:48:04Z","idMessage":12}],"PageNumber":0,"PageSize":20,"Skipped":0,"TotalElementsCount":3}
Paging and filtering (example)	N/A

Email Statistics