DRAFT

This page provides you information about how to use MailUp REST API to create email messages and to send them to specified recipients.

Reference Links

On this page:

Email messages

An email message is always created inside the environment of a MailUp list, so it cannot be managed outside of that list.

Please note that, when creating a new email message, any referenced tag or attachment must be created in advance for that list.

Create a message

Please note that, when creating a new email message, any referenced tag or attachment must be created in advance for that list.

Description	Create a new email message
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... {"Subject":"Monthly Newsletter 4","idList":2,"Content":"Hello world","Embed":false,"Fields":[],"IsConfirmation":false,"Notes":"Issue n. 5","Tags":null,"TrackingInfo":{"CustomParams":"","Enabled":true,"Protocols":["http:","https:","ftp:","news:"]}}
JSON response (example)	{"Subject":"Monthly Newsletter 4","idList":2,"idMessage":47}
Paging and filtering (example)

List Messages

Description	Retreive email messages of specified list
HTTP Method	GET
URL	Retreive all email messages of that list GET 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) GET https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Online/Emails Retreive only email messages that have been archived (i.e. with public visibility, see details) GET https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Archived/Emails *an empty list is returned if public visibility of messages (aka Web library) is disabled. You shall enable it to retreive them
JSON request (example)	none
JSON response (example)	All email messages of specified list 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} List published messages (public URLs are also provided) Click here to expand... "LastSendDate":"0001-01-01 00:00:00Z" is returned when message has never been sent {"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 Click here to expand... {"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 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	Retrieve the email details (content, settings, attachment) by specified id
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)	Message content 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}]} Message attachments Click here to expand... [{"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

This method allows you to modify an existing message (content and settings).

Please note that

"Tags" field is mandatory, if you leave it empty the existing tags of that message are not modified. There is no way to clear all tags
"Fields" parameter is optional
"TrackingInfo > Protocols" field values are ignored if "TrackingInfo > Enabled" is set to false

Description	Modify an existing message
HTTP Method	PUT
URL	https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Email/{id_Message}
JSON request (example)	Request data format is the same as the response of "GET /Console/List/{id_List}/Email/{id_Message}" Click here to expand... {"Subject":"Annual Newsletter n.9","idList":2,"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,"IsConfirmation":false,"Notes":"Issue n. 9 June 2014","Tags":[],"TrackingInfo":{"CustomParams":"","Enabled":true,"Protocols":["http:","ftp:","news:"]}}
JSON response (example)	{"Subject":"Monthly Newsletter!","idList":2,"idMessage":24}
Paging and filtering (example)	none

Manage tags

Description	Read available tags for a specified list
HTTP Method	GET, POST, PUT, DELETE
URL	Retrieve list tags: GET https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Tags Create a new tag: POST https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Tag Modify a tag: PUT https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Tag/{id_Tag} Remove a list tag: DELETE https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Tag/{id_Tag}
JSON request (example)	No request body is required for GET and DELETE methods POST method requires a simple string as parameter (e.g. "my-new-tag"), not a JSON structure PUT method requires a full structure like {"Enabled":true,"Id":6,"Name":"my-new-tag"}
JSON response (example)	GET method returns the retrieved tags list Click here to expand... {"IsPaginated":false,"Items":[{"Enabled":true,"Id":5,"Name":"news"},{"Enabled":true,"Id":4,"Name":"users-manual"},{"Enabled":true,"Id":3,"Name":"$5 off promo"},{"Enabled":true,"Id":2,"Name":"preferred customer"},{"Enabled":true,"Id":1,"Name":"promotion"}],"PageNumber":0,"PageSize":20,"Skipped":0,"TotalElementsCount":5} POST and PUT methods return the full structure of the created/updated tag, e.g. {"Enabled":true,"Id":6,"Name":"my-new-tag"} An empty response is returned by DELETE method
Paging and filtering (example)	none

Manage email attachments

MailUp messages support a maximum of five attachments. Each attachment is placed in a specified "slot": adding and removing an attachment means adding to a message "slot" or removing from it.

Description	Read, add and remove message attachments
HTTP Method	GET, POST, DELETE
URL	Retreive all the attachments of a specified message GET https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Email/{id_Message}/Attachment Add an attachment to message slot POST https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Email/{id_Message}/Attachment/{Slot} Remove an attachment from a message slot DELETE https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Email/{id_Message}/Attachment/{Slot}
JSON request (example)	Only POST method needs a request parameter. Attachment has to be Base64 encoded Click here to expand...
JSON response (example)	GET method returns a list of the documents that are attached to specified message. An empty array ([], not JSON format) is returned if no document is attached. Click here to expand... In this case the specified message (with ID=28) has five attachments [{"Name":"28\/readme.txt","Path":"http:\/\/d0i4f.s57.it\\d0i4f\\download\\28\\28\/readme.txt","Slot":1},{"Name":"28\/optin1.csv","Path":"http:\/\/d0i4f.s57.it\\d0i4f\\download\\28\\28\/optin1.csv","Slot":2},{"Name":"28\/product-logo.png","Path":"http:\/\/d0i4f.s57.it\\d0i4f\\download\\28\\28\/product-logo.png","Slot":3},{"Name":"28\/Feature User Guide 1 0.pdf","Path":"http:\/\/d0i4f.s57.it\\d0i4f\\download\\28\\28\/Feature User Guide 1 0.pdf","Slot":4},{"Name":"28\/max.jpg","Path":"http:\/\/d0i4f.s57.it\\d0i4f\\download\\28\\28\/max.jpg","Slot":5}]
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