This page provides you with information about how to use MailUp REST API to create text messages (SMS) and to send them to specified recipients.
On this page:
In the case of already existing recipients the following behavior applies to subscriptions:
The import process can recognize existing recipients, using the mobile number as unique identifiers, and update them according to the given input details. It is possible to add some query string parameters to specify some advanced behavior for the import process:
Description | Asynchronous import of one or more recipients on SMS channel | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
HTTP Method | POST | ||||||||||||||||
URL |
| ||||||||||||||||
Reference |
| ||||||||||||||||
JSON request (example) |
| ||||||||||||||||
JSON response (example) | Returns import ID | ||||||||||||||||
Paging and filtering (example) |
Description | Specific methods are available for retrieving recipients that are, respectively, subscribed, pending, or unsubscribed on the SMS channel. | ||
---|---|---|---|
HTTP Method | GET | ||
URL |
| ||
Reference | Automated docs are available for Subscribed, Pending, and Unsubscribed | ||
JSON request (example) | |||
JSON response (example) |
| ||
Paging and filtering (example) |
A text 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 text message, any referenced tag must be created in advance for that list.
Known limitations:
Description | Create a new text message | ||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
HTTP Method | POST | ||||||||||||||||||||||||||||
URL |
| ||||||||||||||||||||||||||||
Reference |
| ||||||||||||||||||||||||||||
JSON request (example) |
| ||||||||||||||||||||||||||||
JSON response (example) |
| ||||||||||||||||||||||||||||
Paging and filtering (example) |
Description | Retrieve text messages of a specified list | ||
---|---|---|---|
HTTP Method | GET | ||
URL |
| ||
Reference | Go to automated doc | ||
JSON request (example) | none | ||
JSON response (example) | All the text messages of a specified list
| ||
Paging and filtering (example) | Use this filter to extract only the SMS messages of list 1 that contain the word "promo" in their subject.
|
Description | Retrieve the text message details by specified message-id | ||
---|---|---|---|
HTTP Method | GET | ||
URL | Retrieve the SMS details by specified id
| ||
Reference | Go to automated doc | ||
JSON request (example) | none | ||
JSON response (example) |
| ||
Paging and filtering (example) |
Description | Update a text message by specifying the message-id | ||
---|---|---|---|
HTTP Method | PUT | ||
URL |
| ||
Reference | Go to automated doc | ||
JSON request (example) |
| ||
JSON response (example) |
| ||
Paging and filtering (example) |
Description | Delete a text message by specifying its ID | |
---|---|---|
HTTP Method | DELETE | |
URL |
| |
Reference | Go to automated doc | |
JSON request (example) | none | |
JSON response (example) | none | |
Paging and filtering (example) |
Regardless of the sender, you set when creating a message, MailUp REST API always sends SMS using the sender that is specified at the list level. If you want to change the sender you must modify the list properties. |
Description | Send a text message to a mobile number by specifying message ID. The recipient is automatically subscribed to the SMS channel of the list in which the message was created. | ||
---|---|---|---|
HTTP Method | POST | ||
URL |
| ||
Reference | Go to automated doc | ||
JSON request (example) |
| ||
JSON response (example) |
| ||
Paging and filtering (example) |
Description | Immediate or scheduled mailing to a list or a group | ||
---|---|---|---|
HTTP Method | POST | ||
URL |
| ||
Reference | Go to automated doc (all operations) | ||
JSON request (example) | none | ||
JSON response (example) |
| ||
Paging and filtering (example) |
Known limitations:
Description | Query the send queue | |||||||
---|---|---|---|---|---|---|---|---|
HTTP Method | GET, POST | |||||||
URL |
| |||||||
Reference | Go to automated doc (all operations) | |||||||
JSON request (example) |
| |||||||
JSON response (example) |
| |||||||
Paging and filtering (example) |
Description | Retrieve the SMS message sending report by specifying SMS ID. | ||
---|---|---|---|
HTTP Method | GET | ||
URL |
| ||
Reference | Go to automated doc | ||
JSON request (example) | none | ||
JSON response (example) |
| ||
Paging and filtering (example) |
Description | Retrieve the SMS message sending report details by specifying SMS ID. | ||
---|---|---|---|
HTTP Method | GET | ||
URL |
| ||
Reference | Go to automated doc | ||
JSON request (example) | none | ||
JSON response (example) |
| ||
Paging and filtering (example) | Use this filter to extract the result of the latest message with ID=24 that was sent to number +3933512345678 If you used the sending method of the Transactional API for SMS you can also filter by the DeliveryId that was returned by that method. GET /Console/Sms/24/Sendings/ReportDetails?DeliveryId=1648 In this case, paging and further filtering is not required since no more than one result can be returned |
Description | Retrieve several account details, including the number of available credits | ||
---|---|---|---|
HTTP Method | GET | ||
URL |
| ||
Reference | Go to automated doc | ||
JSON request (example) | none | ||
JSON response (example) |
| ||
Paging and filtering (example) |