Email messages

Create a new email message

POST

Create a message

Enable or disable dynamic fields

PUT

Create a message

Enable or Disable

Message details are returned

Retrieve email messages of a specified list

GET

Retrieve all email messages of that list

Retrieve only email messages that have been published (i.e. with public visibility, see details) ¹

Retrieve only email messages that have been archived (see details) ¹

Note:

¹ an empty list is returned if public visibility of messages (aka Web library) is disabled. You shall enable it to Retrieve them

none

All email messages of a specified list

List published messages (public URLs are also provided)

List archived messages

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"

Retrieve the email details (content, settings, attachment) by specified id

GET

Retrieve the email details by specified id

Get attachment list for the specified message-id

none

Message content

Known limitation: returned values for "PreHeader" and "CreationDate" tags are always "null" 

Message attachments

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"

Modify an existing message

PUT

Request data format is the same as the response of "GET /Console/List/{id_List}/Email/{id_Message}"

none

Read available tags for a specified list

GET, POST, PUT, DELETE

Retrieve list tags:

Create a new tag:

Modify a tag:

Remove a list tag:

• 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"}

GET method returns the retrieved tags list

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

none

Read, add and remove message attachments

GET, POST, DELETE

Retrieve all the attachments of a specified message

Add an attachment to the message slot

Remove an attachment from a message slot

Only the POST method needs a request parameter. The attachment has to be Base64 encoded

The GET method returns a list of the documents that are attached to the specified message. An empty array ([], not JSON format) is returned if no document is attached.

POST method returns the list of attachments after the command execution

DELETE method returns details about remaining attachments after deletion

none

Copy an existing message

POST

Create a message

Copy message as-is:

Copy message modifying Notes:

Copy message modifying Subject:

Copy message modifying Subject and Notes:

Publish an existing message

PUT

Create a message

Publish a message:

Unpublish a message:

None 

SenderName
SenderAddress

Email messages are usually sent with the sender name and the sender name that is specified as default settings for the MailUp list.
As an alternative, you can specify a different sender for a certain sending by specifying "SenderName" and "SenderAddress" parameters.
You have to provide both parameters and not only one of them.

POST .../Send?SenderName="John Smith"&SenderAddress="smith@example.com"

DateTime

It is possible to specify an eventual UTC date/time for a deferred sending.
When a message send is scheduled you cannot modify it.
The format described in the section 'Type and cast definition' of this page: "Paging and filtering".

POST .../Send?datetime="2014-10-20 05:00:00Z"

It is possible to specify the value undefined for the DateTime query string parameter.
It means the message sending is scheduled as inactive. This option allows you to create a relationship between the message and the recipients, as a snapshot: you can modify the message and when the message is ready you can decide to schedule the newsletter or to send it immediately.

POST .../Send?datetime="undefined"

It is possible to omit the DateTime query string parameter (default) or set its value to now.
It means the message is enqueued and it will be sent when the dequeue process reaches it.

POST .../Send

POST .../Send?datetime="now"

replyto

It is possible to specify an email address for a reply.

POST .../Send?replyto="replyto@yourdomain.it"

Send a message to all list subscribers

POST

 Use the default list sender

Use the sender that is provided by query string parameters

none

See notes at the bottom of this page¹

none

You 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 query string 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 query string parameter to set the IDs of the MailUp groups to be included (i.e. all the group members will be added)

• use the notInGroups query string 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.

POST

Inclusion

Include recipients that belong to one or more groups.
It is mandatory that at least one of 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
If a recipient belongs to more than one group, it will be added just one time.

Exclusion

Exclude subscribers 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 recipient and sends the newsletter to all the MailUp list recipients.

Inclusion and exclusion

This is a case that merges the cases seen above: both inGroups and notInGroups are used.

inGroups: at least one of the provided groups must belong 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 recipient and sends the newsletter to all the recipients filtered by the inGroups parameter.

none