Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Description

Asynchronous import of one or more recipients on SMS channel

HTTP Method

POST

URL

Code Block
languagexml
titleAdd to a MailUp list
https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Sms/List/{id_List}/Recipients
Code Block
languagexml
titleAdd 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
titleClick 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 NameTypeDescription
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

NameStringNot used but required, it can be empty (i.e. "Name":"")
MobileNumberStringNumber format is checked by an asynchronous process, hence in case of invalid number import fails but no error is returned
MobilePrefixString

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
languagexml
[{
  "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)

 

 

...