Skip to end of metadata
Go to start of metadata

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:

 


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

Important about creating a new message

Icon
  1. any referenced tag or attachment must be created in advance for that list
  2. to enable use of dynamic fields, which are disabled by default, choose one of these options:
    1. specify at least one default value in the "Fields" parameter (as in the sample request below);
    2. use the EnableDynamicFields method;
    3. use the request property UseDynamicField: true

Description

Create a new email message

HTTP Method

POST

URL

Create a message

JSON request (example)

 Enable dynamic fields defining at least one of them: click here to expand...
 Enable dynamic fields using UseDynamicFields field: click here to expand...
 Leave dynamic fields disabled: click here to expand...

JSON response (example)

 

 

Paging and filtering (example)

 

 

Enable Dynamic fields

Description

Enable or disable dynamic fields

HTTP Method

PUT

URL

Create a message

JSON request (example)

Enable or Disable

 

 

JSON response (example)

Message details are returned

 

 

Paging and filtering (example)

 

 

 

List Messages

DescriptionRetrieve email messages of specified list

HTTP Method

GET

URL

Retrieve all email messages of that list

 

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

 

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

 

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

 Click here to expand...
 About ServiceType field...

ServiceType field shows the message types. Here the most common values:

ValueDescription
0Newsletter
1SMTP+

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)

 Click here to expand...

"LastSendDate":"0001-01-01 00:00:00Z" is returned when message has never been sent

 

List archived messages

 Click here to expand...

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"

Read message details

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

HTTP Method

GET

URL

Retrieve the email details by specified id

 

Get attachment list for the specified message id

JSON request (example)

none

JSON response (example)

Message content

 Click here to expand...

 

Message attachments

 Click here to expand...

Paging and filtering (example)

2 items per page, get first page (count starts from zero)

Retrieve messages that contain the word "test" in the subject field and order by ID. Note: search by text is case sensitive

Sending Queue Status

It is possible to retrieve the status of the sending queue for the outgoing messages by calling the following methods:

1)  status of ongoing sendings: GET https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Email/Sendings/Immediate

2)  status of waiting sendings: GET https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Email/Sendings/Deferred

3)  status of sending to be planned: GET https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Email/Sendings/Undefined

Moreover, it is possible to retrieve the first available date to send a specific sending:

GET https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Email/Sending/{id_sending}/Deferred

where {id_sending} is the unique identifier of the sending to consider. The result is the date UTC date specified with the format described in the section 'Type and cast definition' of this page: "Paging and filtering".

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
DescriptionModify an existing message

HTTP Method

PUT

URL

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...

JSON response (example)

Paging and filtering (example)

none

Manage tags

DescriptionRead available tags for a specified list

HTTP Method

GET, POST, PUT, DELETE

URL

Retrieve list tags:

Create a new tag:

Modify a tag:

Remove a list 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...


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.

DescriptionRead, add and remove message attachments

HTTP Method

GET, POST, DELETE

URL

Retrieve all the attachments of a specified message

 

Add an attachment to message slot

 

Remove an attachment from a message slot

JSON request (example)

Only POST method needs a request parameter. Attachment has to be Base64 encoded

 Click here to expand...

You can use a free tool like this to quickly get the Base64 version of an uploaded file (please note that some tools introduce special chars like CR or LF inside the Base64 string, remove them to avoid HTTP 400 errors)

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

 

POST method returns the list of attachments after the command execution

 Click here to expand...

 

DELETE method returns details about remaining attachments after deletion

 Click here to expand...

The same result is returned even if an empty slot is specified (of course in this case no deletion occurs)

Paging and filtering (example)

none

Copy message

Description

Copy an existing message

HTTP Method

POST

URL

Create a message

JSON request (example)

Copy message as is:

Copy message modifying Notes:

Copy message modifying Subject:

Copy message modifying Subject and Notes:

JSON response (example)

 

 

 

Paging and filtering (example)

 

Manage message online visibility

Description

Publish an existing message

HTTP Method

PUT

URL

Create a message

JSON request (example)

Puslish a message:

Unpuslish a message:

JSON response (example)

None 

Paging and filtering (example)

 

Send Email Messages

This section contains methods to send messages and to retrieve the history of sent messages.

You can enrich the calls to send messages using some querystring parameters, as follow:

Querystring parameterDescriptionExample
SenderName
SenderAddress
Email messages are usually sent with the sender name and the sender name that are 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 sending 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 datetime querystring 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 querystring 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.

Important tip!

Icon

As you can immagine, if you use this option to send to some recipients and you use the method to send to a single recipient now, you append a lot of items to your sending queue. Every time an item is processed, it starts a verification process that requires some seconds: if you enqueue 10.000 items your sending period could be very long. So, if you need to send to a single recipient we suggest to use our Transactional Emails APIs; otherwise, please use list or groups to enqueue multi-recipients items to the sending queue.

POST .../Send

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

replytoIt is possible to specify an email address for reply.POST .../Send?replyto="replyto@yourdomain.it"
Icon

Message sending fails with HTTP 500 error if no authorized sender email nor sender email are provided. Ensure that sender name and sender email have been configured at list level (starting from MailUp version 8.6.1 the sender address has also to be a verified address)

 

Send to all subscribers

DescriptionSend a message to all list subscribers

HTTP Method

POST

URL

 Use the default list sender

Use the sender that is provided by querystring parameters

JSON request (example)

none

JSON response (example)

See notes at the bottom of this page1

Paging and filtering (example)

none

Send to list recipients filtering by groups

Description

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 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 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 recipients 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 of that merges the cases seen above: both inGroups  and notInGroups are used.

inGroups: it is mandatory that at least one of 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 recipient and sends the newsletter to all the recipients filtered by the inGroups parameter.

JSON request (example)

none

JSON response (example)

See notes at the bottom of this page1

Paging and filtering (example)

none


Send to a group

Use the default list sender or a sender that is provided by querystring parameters (see example above)

DescriptionSend a message to all subscribers of specified group

HTTP Method

POST

URL

JSON request (example)

none

JSON response (example)

See notes at the bottom of this page1

Paging and filtering (example)

none

Send to a recipient

Use the default list sender or a sender that is provided by querystring parameters (see example above)

DescriptionSend message to a single recipient

HTTP Method

POST

URL

JSON request (example)

JSON response (example)

See notes at the bottom of this page1

Paging and filtering (example)

none

Retrieve sending history

An email message can be sent several times. This feature allows to retrieve details about each sending.

DescriptionRetrieve information about sent history

HTTP Method

GET

URL

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

Paging and filtering (example)

N/A

 

  1. "Id" is the sending identifier. "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. 

Stop a sending

Use this endpoint to stop a specified sending. It works on scheduled or immediate sendings. It does not change the status of undefined / standby sendings.

You can perform max 1 request every 30 seconds.

DescriptionStop a sending

HTTP Method

POST

URL

JSON request (example)

none

JSON response (example)

none

Paging and filtering (example)

none

Delete a sending

If you've already stopped the sending, use this endpoint to delete it. You MUST call the Stop a sending endpoint before to delete scheduled or immediate in progress sendings. A standby sending does not require to be stopped.

You can perform 1 request every 30 seconds max.

DescriptionDelete a sending

HTTP Method

DELETE

URL

JSON request (example)

none

JSON response (example)

 If the sending should not be deleted...
200 OK
 
{
	"IsDeleted": false
}
 If the sending is deleted...
200 OK
 
{
	"IsDeleted": true
}

Paging and filtering (example)

none

  • No labels