...
- already subscribed remain subscribed
- pending or unsubscribed on SMS channel do not change their subscription status
The import process is able to 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 querystring parameters to specify some advanced behavior for the import process:
- clearMissingOrEmptyFields: if specified, the import process updates to empty every missing or empty field contained in the request body.
- removeFromPrevGroups: if specified, the import process removes the given recipients from current groups and it adds them to that specified in the request. The querystring parameter can be used only in import to group calls.
Description | Asynchronous import of one or more recipients on SMS channel |
|---|
HTTP Method | POST |
|---|
URL | | Code Block |
|---|
| language | xml |
|---|
| title | Add to a MailUp list |
|---|
| https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Sms/List/{id_List}/Recipients |
| Code Block |
|---|
| language | xml |
|---|
| title | Add to a MailUp group |
|---|
| https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Sms/Group/{id_Group}/Recipients |
|
|---|
| Reference | Go to automated doc | Expand |
|---|
| title | Click here to learn more about request parameters |
|---|
| Request is composed of a list of comma separated objects, each one of them is composed of the following mandatory fields: | Field Name | Type | Description |
|---|
| Fields | Array of objects [0..39].
Each object is composed of
the following fields: - Description (String, optional)
- Id (Integer, from 1 to 39)
- Value (String)
| Each array object is a personal data field. If recipient is already existing, the "fields" values can be used to update recipient's personal data | | Name | String | Not used but required, it can be empty (i.e. "Name":"") | | MobileNumber | String | Number format is checked by an asynchronous process, hence in case of invalid number import fails but no error is returned | | MobilePrefix | String | International prefix. Allowed formats are: - prefix with 00 (e.g. "0039")
- prefix with + (e.g. "+39")
- empty prefix (e.g. "", default list prefix is applied)
|
|
|
|---|
JSON request (example) | | Expand |
|---|
| Code Block |
|---|
| [{
"Fields":[{
"Description":"String content",
"Id":1,
"Value":"String content"
}],
"Name":"String content",
"MobileNumber":"10123456",
"MobilePrefix":"0039"
}]
|
|
|
|---|
JSON response (example) | Returns import ID |
|---|
Paging and filtering (example) | |
|---|
...