...
| Description | Retreive email messages of specified list | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
HTTP Method | GET | |||||||||||
URL | JSON response (example) | |||||||||||
| Expand | ||||||||||||
| Code Block | Retreive all email messages of that list
Retreive only email messages that have been published (i.e. with public visibility, see details)
| |||||||||||
JSON request (example) | none | |||||||||||
Retreive 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 retreive them | ||||||||||||
JSON request (example) | none | |||||||||||
JSON response (example) | ||||||||||||
| Description | Retrieve the email details (content, settings, attachment) by specified id | |||||||||||
HTTP Method | GET | |||||||||||
URL |
| Code Block |
|---|
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
All email messages of specified list
| Expand | ||
|---|---|---|
|
All List published messages (public URLs are also provided)
| Expand | ||
|---|---|---|
"LastSendDate":"0001-01-01 00:00:00Z" is returned when message has never been sent
|
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
Retreive 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"
Read message details
List archived messages
| ||||
Paging and filtering (example) | 2 items per page, get first page (count starts from zero)
| {id_List}/Email/{id_Message}/Attachment|||
|---|---|---|---|---|
JSON request (example) | none | |||
JSON response (example) | Message content Expand | Code Block |
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 | 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) | ||||||||||
| Description | Modify an existing message | |||||||||
HTTP Method | PUT | |||||||||
URL | ||||||||||
| Code Block | 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 (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
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 (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 |
Manage tags
| Description | Read available tags for a specified list | |||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
HTTP Method | GET, POST, PUT, DELETE | |||||||||||||||||||
URL | Retrieve list tags:
| JSON request (example) | Request data format is the same as the response of "GET
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
| Protocols
| [
| http:
| ,"ftp
| ,
| news:"]}}||||||||||||||
JSON response (example) |
| |||||||||||||||||||
Paging and filtering (example) | none |
Manage tags
| Description | Read available tags for a specified list | |||||||
|---|---|---|---|---|---|---|---|---|
HTTP Method | GET, POST, PUT, DELETE | |||||||
URL |
| Code Block |
|---|
GET https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Tags |
Create a new tag:
| Code Block |
|---|
POST https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Tag |
Modify a tag:
|
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.
| Description | Read, add and remove message attachments | |||||
|---|---|---|---|---|---|---|
HTTP Method | GET, POST, DELETE | |||||
URL | Retreive all the attachments of a specified message
Add an attachment to message slot
| |||||
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) |
| 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
| Description | |||||
|---|---|---|---|---|---|
HTTP Method | GET | ||||
URL |
| ||||
JSON request (example) | none | ||||
JSON response (example) |
Remove an attachment from a message slot
| ||||
JSON request (example) | Only POST method needs a request parameter. Attachment has to be Base64 encoded
| ||||
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.
| ||||
Paging and filtering (example) |
...