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
REST API include either a method for single (refer to "Update subscription") or bulk (asynchronous import with "asOptout" option) unsubscription.
Trust your list's email addresses
When you create a list, you need to set two email addresses
- owneremail
- replyto
You should trust these email addresses for security reasons, so you can use TrustedSenders resource to do this job.
The folowing table shows the trusted sender statuses:
StatusCode | StatusDescription | Description |
---|---|---|
0 | NotConfirmed | You have just requested to trust an email address |
1 | Confirmed | You click on the verification link received by email: now youe email address is trusted |
2 | Blocked | You disable a trusted sender |
Trust an email address
Description | Use this method to trust an email address.
that tell you that this email should be verified. Please note that every time you call this method specifying an email address, even if you have already verified it, you'll receive an email containing the verification link and the system updates the 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) |
|
Get trusted email addresses
Description | Use this method to retrieve the list of trusted 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)
|
|
Get a trusted email address details
Description | Use this method to retrieve a trusted 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)
|
|
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. | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
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) |
| |||||||||||
...
Groups
Create Group
Description | Create a group into the specified list. Group ID is returned | |||||
---|---|---|---|---|---|---|
HTTP Method | POST | |||||
URL | https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{ID_LIST}/Group | |||||
Reference | Go to automated doc | |||||
JSON request (example) |
| |||||
JSON response (example) |
| |||||
Paging and filtering (example) | none |
...