Page Comparison

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

...

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

...

Note

title	Important about creating a new

...

message

...

any referenced tag or attachment must be created in advance for that list

...

you must specify at least one default value in the "Fields" parameter (as in the sample request below) to enable use of dynamic fields, which are disabled by default. Otherwise you can also use the EnableDynamicFields method

Description

Create a new email message

HTTP Method

POST

URL

Code Block

title	Create a message

https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Email

JSON request (example)

Expand

Code Block

{"Subject":"Monthly Newsletter 4","idList":2,"Content":"Hello world","Embed":false,"Fields":[]{"Description":"Country","IsConfirmationId":false8,"NotesValue":"IssueUSA"}],"IsConfirmation":false,"Notes":"Issue n. 5","Tags":null,"TrackingInfo":{"CustomParams":"","Enabled":true,"Protocols":["http:","https:","ftp:","news:"]}}:","ftp:","news:"]}}

JSON response (example)

Code Block
{ "CreationDate": "2016-09-16 15:57:35Z", "Notes": "", "Subject": "Monthly Newsletter 4", "idList": 2, "idMessage": 1060 }

Paging and filtering (example)

Enable Dynamic fields

Description

Enable or disable dynamic fields

HTTP Method

PUT

URL

Code Block

title	Create a message

https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/list/{id_List}/Email/{id_Message}/EnableDynamicFields/{enable}

JSON request (example)

Code Block

title	Enable or Disable

https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/list//Email/1061/EnableDynamicFields/true
https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/list//Email/1061/EnableDynamicFields/false

JSON response (example)

Code Block{"Subject":"Monthly Newsletter 4","idList":2,"idMessage":47}

Message details are returned

Paging and filtering (example)

List Messages

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)

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 (i.e. with public visibility, see details)

Code Block
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 Retrieve them

JSON request (example)

none

JSON response (example)

All email messages of specified list

Expand

Code Block

{"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)

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"

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

Code Block
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

Code Block
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

Expand

Code Block

{"Subject":"Monthly Newsletter","idList":2,"idMessage":24,"Content":"
<table><tbody><tr><td><strong>Image</strong>&nbsp;</td><td><strong>Text</strong>&nbsp;</td></tr><tr><td style="width: 200px; height: 70px;">&nbsp;<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>&nbsp;This screenshot shows you how to perform login with social networks<br>&nbsp;(see <a href="http://[track]/https://help.mailup.com" target="_blank" id="User" s="" manual'="">manual</a>)&nbsp;</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

Expand

Code Block
[{"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

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"

...

"Sent" is the size of the sending queue and may include either previously enqueued recipients or, despite of its name, discarded recipients (invalid or unprocessed). "InvalidRecipients" is expected to be always empty when sending to all list subscribers or to a group. "UnprocessedRecipients" contains a list of recipients that are excluded from sending due to a restriction (e.g. in case of a trial console account or when the rate limiting described in API use policy is exceeded)

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

Versions Compared

Old Version 25

New Version 26

Key

Create a message

Enable Dynamic fields

List Messages

Read message details