Versions Compared

Key

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

...

  • Any text between square brackets must match with the name of a dynamic field that is available for that account
  • In some countries, like Italy, some restrictions on SMS senders apply. Use MailUp admin console to verify if the specified sender is subject to limitations in some countries
  • MailUp REST API applies, on Sender field alphanumeric senders, looser format restrictions than the admin console. While admin console allows only letters and numbers, API also allow spaces, puntuaction and other special characters. Please consider that letters and numbers are supported by any carrier, while other characters may be replaced in some cases. It is recommended that you perform some tests before using a sender with spaces, puntuaction or special characters
  • In case of empty Sender the default list settings are not applied, a random numeric sender is used instead

Description

Create a new text message

HTTP Method

POST

URL

Code Block
languagexml
https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Sms/List/{id_List}/Message
Reference

Go to automated doc

Expand
titleClick here to learn more about request parameters
Field NameTypeDescription
 SubjectStringMessage title (for MailUp users only, it will not be visible to recipients)
 idListIntegerList ID
ContentStringMessage content
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 will be used to fill the correspondent dynamic field when its value has been left empty or blank.

NotesStringMessage notes (for MailUp users only, it will not be visible to recipients)
TagsArray of objects
Each object is composed of
the following fields:  
  • Enabled (Boolean)
  • Id (Integer, from 1 to 39)
  • Value (String)

Optional field, used to link existing tags to the text message.

Tags can be used to classify messages, please check this page for more details about tags

IsUnicodeBooleanFalse if message contains only letters or symbols that belong to Western alphabet (GSM charset).
True if at least one message character belongs to a non-western alphabet (Unicode)
SenderString

Message sender. It can be a phone number (e.g. +393351234567) or a string (up to 11 chars,

only letters and number). Please note that in some country, like Italy, some restrictions on SMS senders apply.

Use MailUp admin console to verify if the specified sender is subject to limitations in some countries.

If you leave this field empty a random numeric value will be applied.

JSON request (example)

Expand

In this case recipients with an empty field as "FirstName" will receive "Hello dear customer, your appointment is confirmed for today at 5PM, Main Building 1st floor"
from "ABCandCO"

Code Block
languagexml
{
    "Subject":"Appointment #1",
    "idList":2,
    "Content":"Hello [firstname], your appointment is confirmed for today at 5PM, Main Building 1st floor",
    "Fields":[{
               "Id":1,
               "Value":"dear customer"
             }],
    "Notes":"Appointment is confirmed",
    "IsUnicode":false,
    "Sender":"ABCandCO"
}

JSON response (example)

Code Block
languagexml
{
   "Subject" : "Appointment #1",
   "idList" : 1,
   "idMessage" : 2
}

 

 

Paging and filtering (example)

 

 

...