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.
Create a message
Description |
|
---|---|
HTTP Method | POST |
URL | https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Email |
JSON request (example) | |
JSON response (example) |
|
Paging and filtering (example) |
|
List Messages
Description | |
---|---|
HTTP Method | GET |
URL | Retreive all email messages of that list https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Emails
Retreive only email messages that have been published (i.e. with public visibility, see details) https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Online/Emails |
JSON request (example) | none |
JSON response (example) |
|
Paging and filtering (example) | 2 items per page, get first page (count starts from zero)
Retreive messages that contain the word "test" in the subject field and order by ID. Note: search by text is case sensitive
|
Read message details
Description | |
---|---|
HTTP Method | GET |
URL | Retrieve the email details by specified id 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 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) |
|
Paging and filtering (example) | 2 items per page, get first page (count starts from zero)
Retreive messages that contain the word "test" in the subject field and order by ID. Note: search by text is case sensitive
|
Update message
Description | |
---|---|
HTTP Method | GET |
URL |
|
JSON request (example) | none |
JSON response (example) |
|
Paging and filtering (example) |
|
Manage tags
Description | |
---|---|
HTTP Method | GET |
URL |
|
JSON request (example) | none |
JSON response (example) |
|
Paging and filtering (example) |
Manage email attachments
Description | |
---|---|
HTTP Method | GET |
URL |
|
JSON request (example) | none |
JSON response (example) |
|
Paging and filtering (example) |
Send Email Messages
Send to all subscribers
Description | |
---|---|
HTTP Method | POST |
URL |
|
JSON request (example) | none |
JSON response (example) |
|
Paging and filtering (example) |
Send to a group
Description | |
---|---|
HTTP Method | POST |
URL |
|
JSON request (example) | none |
JSON response (example) |
|
Paging and filtering (example) |
Send to a recipient
Description | |
---|---|
HTTP Method | POST |
URL |
|
JSON request (example) | none |
JSON response (example) |
|
Paging and filtering (example) |
Retreive sending history
An email message can be sent several times. This feature allows to retreive details about each sending.
Description | |
---|---|
HTTP Method | GET |
URL | /Console/List/{id_List}/Email/{id_Message}/SendHistory |
JSON request (example) | none |
JSON response (example) | |
Paging and filtering (example) | N/A |