...
This page provides you information about how to use MailUp REST API to create email messages and to send them to specified recipients.
| Panel | ||
|---|---|---|
| ||
On this page:
| Table of Contents |
|---|
...
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
...
Description
...
Please note that, when creating a new email message
...
HTTP Method
, any referenced tag or attachment must be created in advance for that list.
Description | Create a new email message | ||||
|---|---|---|---|---|---|
HTTP Method | POST | ||||
URL |
| ||||
JSON request (example) |
| ||||
JSON response (example) |
| ||||
Paging and filtering (example) |
|
...
| 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)
Retreive messages that contain the word "test" in the subject field and order by ID. Note: search by text is case sensitive
|
Update message
...
This method allows you to modify an existing message
...
HTTP Method
...
PUT
...
URL
...
| Code Block |
|---|
https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Email/{id_Message} |
...
JSON request (example)
...
(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
| Description | Modify 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}"
| |||||
JSON response (example) |
| |||||
Paging and filtering (example) | none |
...
| Description | Read available tags for a specified list | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
HTTP Method | GET, POST, PUT, DELETE | ||||||||||
URL | Retrieve list tags:
Create a new tag:
Modify a Modify a tag:
Remove a list tag:
Remove a list tag:
| ||||||||||
JSON request (example) | none | ||||||||||
JSON response (example) | 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
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 |
...