Page Comparison

...

Description

Asynchronous import of one or more recipients on SMS channel

HTTP Method

POST

URL

Code Block
https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Sms/{id_List}/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)

Text messages

A text message is always created inside the environment of a MailUp list, so it cannot be managed outside of that list.

Create a message

Please note that, when creating a new email message, any referenced tag or attachment must be created in advance for that list.

...

Description

...

Create a new text message

...

HTTP Method

...

Read recipients

Description

Specific methods are available for retrieving recipients that are, respectively, subscribed, pending or unsubscribed on SMS channel.

HTTP Method

GET

URL

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

Reference

JSON request (example)

{"Subject":"Monthly Newsletter 4","idList":2,"Content":"Hello world","Embed":false,"Fields":[],"IsConfirmation":false,"Notes":"Issue n. 5","Tags":null,"TrackingInfo":{"CustomParams":"","Enabled":true,"Protocols":["http:","https:","ftp:","news:"]}}

Recipients/Subscribed
https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Sms/List/{id_List}/Recipients/Pending
https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Sms/List/{id_List}/Recipients/Unsubscribed

Expand

Code Block

Reference

Automated docs are available for Subscribed, Pending and Unsubscribed

JSON request (example)

JSON response (example)

Expand

The same data format is used in the responses related to "Subscribed", "Pending" and "Unsubscribed". Full recipient details are returned.

Code Block

{
   "IsPaginated" : false,
   "Items" : [
      {
         "Fields" : [
            {
               "Description" : "LatestOrderAmount",
               "Id" : 15,
               "Value" : ""
            },
            {
               "Description" : "FirstName",
               "Id" : 1,
               "Value" : "Mary"
            },
            {
               "Description" : "Region",
               "Id" : 8,
               "Value" : ""
            },
            {
               "Description" : "LatestOrderProductIDs",
               "Id" : 16,
               "Value" : ""
            },
            {
               "Description" : "LastName",
               "Id" : 2,
               "Value" : "Johnson"
            },
            {
               "Description" : "Address",
               "Id" : 9,
               "Value" : ""
            },
            {
               "Description" : "LatestOrderCategoryIDs",
               "Id" : 17,
               "Value" : ""
            },
            {
               "Description" : "Company",
               "Id" : 3,
               "Value" : ""
            },
            {
               "Description" : "Gender ",
               "Id" : 10,
               "Value" : ""
            },
            {
               "Description" : "LatestShippedOrderDate",
               "Id" : 18,
               "Value" : ""
            },
            {
               "Description" : "City",
               "Id" : 4,
               "Value" : ""
            },
            {
               "Description" : "phone",
               "Id" : 11,
               "Value" : ""
            },
            {
               "Description" : "LatestShippedOrderID",
               "Id" : 19,
               "Value" : ""
            },
            {
               "Description" : "Province",
               "Id" : 5,
               "Value" : ""
            },
            {
               "Description" : "CustomerID",
               "Id" : 12,
               "Value" : ""
            },
            {
               "Description" : "LatestAbandonedCartDate",
               "Id" : 20,
               "Value" : ""
            },
            {
               "Description" : "ZIP",
               "Id" : 6,
               "Value" : ""
            },
            {
               "Description" : "LatestOrderID",
               "Id" : 13,
               "Value" : ""
            },
            {
               "Description" : "State",
               "Id" : 7,
               "Value" : ""
            },
            {
               "Description" : "LatestOrderDate",
               "Id" : 14,
               "Value" : ""
            },
            {
               "Description" : "LatestAbandonedCartTotal",
               "Id" : 21,
               "Value" : ""
            },
            {
               "Description" : "LatestAbandonedCartID",
               "Id" : 22,
               "Value" : ""
            },
            {
               "Description" : "TotalOrdered",
               "Id" : 23,
               "Value" : ""
            },
            {
               "Description" : "TotalOrderedLast12m",
               "Id" : 24,
               "Value" : ""
            },
            {
               "Description" : "TotalOrderedLast30d",
               "Id" : 25,
               "Value" : ""
            },
            {
               "Description" : "AllOrderedProductIDs",
               "Id" : 26,
               "Value" : ""
            }
         ],
         "Name" : null,
         "idRecipient" : 15,
         "Email" : null,
         "MobileNumber" : "323456789",
         "MobilePrefix" : "001"
      }
   ],
   "PageNumber" : 0,
   "PageSize" : 10,
   "Skipped" : 0,
   "TotalElementsCount" : 1
}

Paging and filtering (example)

Text messages

A text message is always created inside the environment of a MailUp list, so it cannot be managed outside of that list.

Create a message

Please note that, when creating a new email message, any referenced tag or attachment must be created in advance for that list.

Description

Create a new text message

HTTP Method

POST

URL

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

Reference

Go to automated doc

Expand

title	Click here to learn more about request parameters

Field Name	Type	Description
Subject	String	Message title (for MailUp users only, it will not be visible to recipients)
idList	Integer	List ID
Content	String	Message 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.
Notes	String	Message notes (for MailUp users only, it will not be visible to recipients)
IsUnicode	Boolean	False 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)
Sender	String	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

{
    "Subject":"Appointment #1",
    "idList":51,
    "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
{ "Subject" : "MonthlyAppointment Newsletter 4#1", "idList" :2, 1, "idMessage" :47 2 }

Paging and filtering (example)

...

Versions Compared

Old Version 1

New Version 2

Key

Text messages

Create a message

Read recipients

Text messages

Create a message