Tip | ||
---|---|---|
| ||
Click here to learn more about the difference between lists and groups in MailUp. |
...
Description | Create a new list | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
HTTP Method | POST | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
URL | https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/User/Lists | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Reference |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
JSON request (example) |
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
JSON response (example) | List ID (e.g. 18)
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Paging and filtering (example) |
|
Update List
Description | Update an existing list | |||||||
---|---|---|---|---|---|---|---|---|
HTTP Method | PUT | |||||||
URL | https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/User/List/{List_ID} | |||||||
Reference | For details about parameters you can look at "Create List" method. | |||||||
JSON request (example) |
| |||||||
JSON response (example) |
| |||||||
Paging and filtering (example) |
|
Read Lists
Description | Return the lists that are visible for authenticated user. If an existing list is not returned it is likely that the MailUp specified with the API is not enabled to see that list. Users with administrators grants can change this setting using the admin console account (i.e. the web application) | |||||||
---|---|---|---|---|---|---|---|---|
HTTP Method | GET | |||||||
URL | https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/User/Lists | |||||||
Reference | Go to automated doc | |||||||
JSON request (example) | none | |||||||
JSON response (example) |
| |||||||
Paging and filtering (example) | 5 items per page, get first page (count starts from zero)
Retreive all the lists whose name contains 'Newsletter' filterby="Name.Contains('Newsletter')" and sort them by ID orderby="idList desc". Parameter names can be retreived from the response body. Please note that "Contains" is case sensitive.
|
Add recipients to a list - subscribe
...
- add and subscribe one or more recipients. See "Import recipients".
- force subscription of an existing recipient (i.e. unsubscribed or pending) by specifiying its ID. Refer to "Update subscription"
Remove recipients from a list - unsubscribe
...
You should trust these email addresses for security reasons, so you can use TrustedSenders resource to do this job.
StatusCode | StatusDescription | Description |
---|---|---|
0 | NotConfirmed | You have just requested to trust an email address |
2 | Blocked | You disable a trusted sender |
The table above does not display statuses that means Ok, your sender's email address is valid!
...
Use this method to trust a sender email address. Calling thie method, you'll send an email to the specified address containing a link to verify it. The response contains the value
...
Trust an email address
Description | Use this method to trust a sender email address. Calling thie method, you'll send an email to the specified address containing a link to verify it. The response contains the value
because the sender email address hasn't been verified yet. When the sender I want to trust click the verification link, the platform trusts the sender and the StatusDescription (and the StatusCode) changes due to some platform checks. Please consider trusted a sender with StatusCode different from 0. You can use this method to re-request to trust a sender email address: in fact, every time you call this method, even if the address is verified, you'll receive an email containing the verification link and the platform updates the sender email address status to NotConfirmed. | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
HTTP Method | POST | |||||||||||
URL | https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/TrustedSenders | |||||||||||
Reference |
| |||||||||||
JSON request (example) |
| |||||||||||
JSON response (example) |
|
...
Description | Use this method to retrieve the list of trusted senders' email addresses. | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
HTTP Method | GET | |||||||||||
URL | https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/TrustedSenders | |||||||||||
Reference | ||||||||||||
JSON request (example) | None | |||||||||||
JSON response (example)
|
The table below shows that you have to consider in your integration.
The table above does not display statuses that means Ok, your sender's email address is trusted! |
Get a trusted email address details
Description | Use this method to retrieve a trusted sender's email address details. | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
HTTP Method | GET | |||||||||||
URL | https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/TrustedSenders/{IdTrustedSender} | |||||||||||
Reference | ||||||||||||
JSON request (example) | None | |||||||||||
JSON response (example)
|
The table below shows that you have to consider in your integration.
The table above does not display statuses that means Ok, your sender's email address is trusted! |
Disable an email address
Description | Use this method to disable a trusted sender. When you disable an email address, you cannot trust it again in the future. When you disable a sender, the trusted sender status is:
If you need to re-trust an email address, please do not disable it, but call the method to Trust an email address to send the email containing the verification link again. | ||||||
---|---|---|---|---|---|---|---|
HTTP Method | DELETE | ||||||
URL | https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/TrustedSenders/{IdTrustedSender} | ||||||
Reference | |||||||
JSON request (example) | For security reason, you need to submit the email address to disable using the If-match header.
| ||||||
JSON response (example) |
| ||||||
...