This page provides you information about how to use MailUp REST API to create email messages and to send them to specified recipients.
...
Note | ||
---|---|---|
| ||
|
Description | Create a new email message | |||||
---|---|---|---|---|---|---|
HTTP Method | POST | |||||
URL |
| |||||
JSON request (example) |
| |||||
JSON response (example) |
| |||||
Paging and filtering (example) |
|
...
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
|
...