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 | ||
---|---|---|
|
...
|
...
|
...
|
Description | Create a new email message | |||||
---|---|---|---|---|---|---|
HTTP Method | POST | |||||
URL |
| |||||
JSON request (example) |
| |||||
JSON response (example) |
| |||||
Paging and filtering (example) |
|
Enable Dynamic fields
Description | Enable or disable dynamic fields | |||||
---|---|---|---|---|---|---|
HTTP Method | PUT | |||||
URL |
| |||||
JSON request (example) |
| |||||
JSON response (example) |
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
Retrieve only email messages that have been published (i.e. with public visibility, see details)
Retrieve only email messages that have been archived (i.e. with public visibility, see details)
*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
List published messages (public URLs are also provided)
List archived messages
| ||||||||||||
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
Retrieve only the messages with tags whose IDs are 1, 13 or 45 (at least one of them).
|
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
Get attachment list for the specified message id
| ||||||||
JSON request (example) | none | ||||||||
JSON response (example) | Message content
Message attachments
| ||||||||
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
|
...
- "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.