Page Comparison

Tip

title	New to MailUp?

Click here to learn more about the difference between lists and groups in MailUp.

...

Description

Create a new list

HTTP Method

POST

URL

https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/User/Lists

Reference

Go to automated doc

Expand

title	Click here to learn more about request parameters

Mandatory fields are marked in bold. To have an example of data formats you can have a look at the response of "Update List" method

Field name	Type	Description
bouncedemail	String	Address for error messages
charset	String	Text charset (see a list of Supported Charsets)
conversionlab_trackcode	String	Code for tracking via conversionlab
default_prefix	String	Default international prefix for mobile numbers (e.g. "0039" for Italy and "001" for United States)
description	String	Additional details about what the list is used for.
disclaimer	String	Heading added to the messages in the list
displayas	String	This is the name that will be displayed in the "To" section of the e-mail message heading. Name can be customized with dynamic fields using "campoN" labels (e.g. campo1,campo2, etc.), where N is the progressive number of the dynamic field
format	String	Format of emails to be sent with this list ("html" or "text")
frontendform	Boolean	Enable hosted subscription forms, which you can view and edit under Settings > List settings > List Building Tools.
headerlistunsubscriber	String	Heading "LIST-UNSUBSCRIBE" added to the messages in the list. Suggested value = "<[listunsubscribe]>,<[mailto_uns]>"
headerxabuse	String	Heading "X-ABUSE" added to the messages in the list. Suggested value = "Please report abuse here: http://[host]/p"
kbmax	Integer	Message size beyond which a warning is generated. Suggested value = 100
multi_optout_list	String	Detail of the list IDs which will be viewed by the user in case of multiple optout (e.g. 1,2,3 etc.). Applies only when optout_type=2
multipart_text	Boolean	Flag to automatically generate a text version of the message at sending stage
nl_sendername	String	Email sender name: the person or entity that is sending the message. It could simply be your company name.
notifyemail	String	Email address for unsubscribe notifications. Each time a recipient unsubscribes, an email will be sent to this address.
optout_type	Integer	Optout settings that apply when a recipient unsubscribe (0: One-click unsubscribe, 1: Confirmed unsubscribe, 2: Confirmed unsubscribe with list preferences, 3: Confirmed unsubscribe with options, 4: Confirmed unsubscribe with Preference Center)
owneremail	String	"FROM" email: the email address that is sending the message. Make sure that it is a recognizable address (e.g. it uses your Web site domain). For security reason, please trust this email address, as explain by the method Trust an email address.
public	Boolean	Flag indicating if the list is visible in the public web library (if you set public=true the created list will be available in http://consoleUrl/frontend/nl_catalog.aspx)
replyto	String	If your newsletter asks for a reply from the recipients, you may want the replies to be sent to a different address from the "FROM" email. Enter the reply-to address here: it must be a valid email address. If you leave the field blank, the "FROM" address (see "owneremail" field) will be used. For security reason, please trust this email address, as explain by the method Trust an email address.
sendconfirmsms	Boolean	True when welcome SMS has to be sent for any new subscriber on SMS channel
sendemailoptout	Boolean	When true a "goodbye email" is sent to recipient that unsubscribe
senderfax	String	Deprecated field, do not use it
senderfaxname	String	Deprecated field, do not use it
sms_sendername	String	Default sender name for text messages. 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.
subscribedemail	Boolean	True when welcome email has to be sent for any new subscriber (it works only when double optin is implemented)
tracking	Boolean	True when link tracking has to be enabled at list level
Customer	Boolean	True if your mailing is directed to consumers
Name	String	List name (max 50 characters)
business	Boolean	True if your mailing is directed to businesses
copyTemplate	Boolean	Deprecated field. Always use "false" value
copyWebhooks	Boolean	When true and an existing list is set as template, then webhooks configuration is copied from that list
idSettings	Integer	ID of an existing list to be used as template. This field is ignored when 'useDefaultSettings=true'
scope	String	select here which type of messages you are sending from this list: "newsletters" (default), "Direct_Advertising" (promotions, direct marketing messages), or "Transactional" (transactional messages like alerts, reminders, notifications)
useDefaultSettings	Boolean	When false, an existing list, specified by 'idSettings' field, is used as template. Otherwise default settings are used

JSON request (example)

Expand

Code Block

{
   "Name":"New Arrivals",
   "useDefaultSettings":false,
   "idSettings":1,
   "business":true,
   "Customer":true,
   "scope":"newsletters",
   "owneremail":"jane@example.com",
   "format":"html",
   "copyTemplate":true,
   "copyWebhooks":true,
   "charset":"UTF-8",
   "public":true,
   "tracking":true,
   "optout_type":0,
   "sendemailoptout":false,
   "frontendform":true,
   "headerxabuse":"Please report abuse here: http://[host]/p",
   "kbmax":100,
   "replyto":"mike@example.com",
   "headerlistunsubscriber":"<[listunsubscribe]>,<[mailto_uns]>",
   "multipart_text":true,
   "subscribedemail":true,
   "sendconfirmsms":false,
}

JSON response (example)

List ID (e.g. 18)

Paging and filtering (example)

Update List

Description

Update an existing list

HTTP Method

PUT

URL

https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/User/List/{List_ID}

Reference

Go to automated doc

For details about parameters you can look at "Create List" method.
In addition, the Update method also requires the IdList field, which is the only mandatory field.

JSON request (example)

Code Block
{ "Name":"New Arrivals", "description":"Use this list to inform subscribers about new products", "IdList":2 }

JSON response (example)

Expand

Code Block

language	html/xml

{
   "bouncedemail" : "g1g7g@g1g7g.bounce.smtpnext.com",
   "charset" : "UTF-8",
   "conversionlab_trackcode" : "",
   "default_prefix" : "001",
   "description" : "Use this list to inform subscribers about new products",
   "disclaimer" : "<br><br><font face=\"Verdana\" size=\"1\" color=\"#666666\">Privacy Protected with <a href=\"http://b1g7g.smtpnext.com/p\" target=_blank>Safely Subscribe System</a></font>",
   "displayas" : "campo1,campo2,campo3",
   "format" : "html",
   "frontendform" : true,
   "headerlistunsubscriber" : "<[listunsubscribe]>,<[mailto_uns]>",
   "headerxabuse" : "Please report abuse here: http://[host]/p",
   "kbmax" : 100,
   "multi_optout_list" : "2",
   "multipart_text" : true,
   "nl_sendername" : "John Smith",
   "notifyemail" : null,
   "optout_type" : 0,
   "owneremail" : "john@example.com",
   "public" : true,
   "replyto" : "mary@example.com",
   "sendconfirmsms" : false,
   "sendemailoptout" : false,
   "senderfax" : "",
   "senderfaxname" : "",
   "sms_sendername" : "SMSText",
   "subscribedemail" : true,
   "tracking" : true,
   "Customer" : true,
   "IdList" : 2,
   "Name" : "New Arrivals",
   "business" : true,
   "scope" : "newsletters"
}

Paging and filtering (example)

Read Lists

Description

Return the lists that are visible for authenticated user. If an existing list is not returned it is likely that the MailUp specified with the API is not enabled to see that list. Users with administrators grants can change this setting using the admin console account (i.e. the web application)

HTTP Method

GET

URL

https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/User/Lists

Reference

Go to automated doc

JSON request (example)

none

JSON response (example)

Expand

Code Block

language	html/xml

{"IsPaginated":false,
"Items":[{"Company":"","Description":"","Name":"Second List ","idList":2,"listGuid":"f34e5054-5555-4444-ffff-51acc36ae104"},
{"Company":"","Description":"This is a description","Name":"Newsletter ","idList":1,"listGuid":"49494949-4444-9999-8888-185543409eb7"}],
"PageNumber":0,"PageSize":5,"Skipped":0,"TotalElementsCount":2}

Paging and filtering (example)

5 items per page, get first page (count starts from zero)

https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/User/Lists?PageNumber=0&PageSize=5

Retreive all the lists whose name contains 'Newsletter' filterby="Name.Contains('Newsletter')" and sort them by ID orderby="idList desc". Parameter names can be retreived from the response body. Please note that "Contains" is case sensitive.

https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/User/Lists?filterby="Name.Contains(%27Newsletter%27)"&orderby="idList+desc"

...

add and subscribe one or more recipients. See "Import recipients".
force subscription of an existing recipient (i.e. unsubscribed or pending) by specifiying its ID. Refer to "Update subscription"

Remove recipients from a list - unsubscribe

...

You should trust these email addresses for security reasons, so you can use TrustedSenders resource to do this job.

StatusCode	StatusDescription	Description
0	NotConfirmed	You have just requested to trust an email address
2	Blocked	You disable a trusted sender

The table above does not display statuses that means Ok, your sender's email address is valid!

...

Use this method to trust a sender email address. Calling thie method, you'll send an email to the specified address containing a link to verify it. The response contains the value

...

Trust an email address

Description

Use this method to trust a sender email address. Calling thie method, you'll send an email to the specified address containing a link to verify it. The response contains the value

No Format
"StatusDescription": "NotConfirmed", "StatusCode": 0

because the sender email address hasn't been verified yet.

When the sender I want to trust click the verification link, the platform trusts the sender and the StatusDescription (and the StatusCode) changes due to some platform checks. Please consider trusted a sender with StatusCode different from 0.

You can use this method to re-request to trust a sender email address: in fact, every time you call this method, even if the address is verified, you'll receive an email containing the verification link and the platform updates the sender email address status to NotConfirmed.

HTTP Method

POST

URL

https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/TrustedSenders

Reference

Go to automated doc

Expand

title	Click here to learn more about request parameters

Mandatory fields are marked in bold.

Field name	Type	Description
Email	String	The email address to be trusted

JSON request (example)

Code Block
{ "Email":"youremailaddress@yourdomain.eu" }

JSON response (example)

Code Block

{
  "AuthorizationDate": "",
  "CreationDate": "2016-11-28 12:34:36Z",
  "EmailAddress": "youremailaddress@yourdomain.eu",
  "IdTrustedSender": "ror11zuGscWcjl7m",
  "StatusCode": 0,
  "StatusDescription": "NotConfirmed",
  "UpdateDate": "2016-11-28 12:34:36Z"
}

...

Description

Use this method to retrieve the list of trusted senders' email addresses.

HTTP Method

GET

URL

https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/TrustedSenders

Reference

Go to automated doc

JSON request (example)

None

JSON response (example)

Code Block

{
  "IsPaginated": false,
  "Items": [
    {
      "AuthorizationDate": "2016-09-22 16:43:55Z",
      "CreationDate": "2016-09-22 16:43:45Z",
      "EmailAddress": "youremailaddress@yourdomain.eu",
      "IdTrustedSender": "ror11zuGscWcjl7m",
      "StatusCode": 70,
      "StatusDescription": "NotConfirmed",
      "UpdateDate": "2016-09-22 16:43:55Z"
    }
  ],
  "PageNumber": 0,
  "PageSize": 20,
  "Skipped": 0,
  "TotalElementsCount": 4
}

The table below shows that you have to consider in your integration.

StatusCode	StatusDescription	Meaning
0	NotConfirmed	You have just requested to trust an email address
2	Blocked	You disable a trusted sender

The table above does not display statuses that means Ok, your sender's email address is trusted!

Get a trusted email address details

Description

Use this method to retrieve a trusted sender's email address details.
It could be useful if you need the status of a trusted sender email address without retrieve all data and navigate the list.

HTTP Method

GET

URL

https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/TrustedSenders/{IdTrustedSender}

Reference

Go to automated doc

JSON request (example)

None

JSON response (example)

Code Block

{
  "AuthorizationDate": "2016-09-22 16:43:55Z",
  "CreationDate": "2016-09-22 16:43:45Z",
  "EmailAddress": "youremailaddress@yourdomain.eu",
  "IdTrustedSender": "ror11zuGscWcjl7m",
  "StatusCode": 70,
  "StatusDescription": "NotConfirmed",
  "UpdateDate": "2016-09-22 16:43:55Z"
}

The table below shows that you have to consider in your integration.

StatusCode	StatusDescription	Meaning
0	NotConfirmed	You have just requested to trust an email address
2	Blocked	You disable a trusted sender

The table above does not display statuses that means Ok, your sender's email address is trusted!

Disable an email address

Description

Use this method to disable a trusted sender. When you disable an email address, you cannot trust it again in the future.

When you disable a sender, the trusted sender status is:

No Format
"StatusDescription": "Blocked", "StatusCode": 2

If you need to re-trust an email address, please do not disable it, but call the method to Trust an email address to send the email containing the verification link again.

HTTP Method

DELETE

URL

https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/TrustedSenders/{IdTrustedSender}

Reference

Go to automated doc

JSON request (example)

For security reason, you need to submit the email address to disable using the If-match header.
Mandatory header are marked in bold.

Header	Value	Description
If-match	{EmailAddress}	The EmailAddress related to the IdTrustedSender defined in the request URL

JSON response (example)

If the EmailAddress matches the IdTrustedSender

Code Block

200 OK

{
  "AuthorizationDate": "",
  "CreationDate": "2016-11-28 12:34:36Z",
  "EmailAddress": "youremailaddress@yourdomain.eu",
  "IdTrustedSender": "ror11zuGscWcjl7m",
  "StatusCode": 2,
  "StatusDescription": "Blocked",
  "UpdateDate": "2016-11-28 12:57:30Z"
}

If the If-Match header misses

Code Block
403 Forbidden { "ErrorCode": "403", "ErrorDescription": "Missing If-Match header.", "ErrorName": "Forbidden", "ErrorStack": "" }

If the If-Match header conatins an email address that does not match with the address identified by IdTrustedSender

Code Block
412 Precondition failed { "ErrorCode": "412", "ErrorDescription": "Invalid [EmailAddress] from If-Match header field.", "ErrorName": "PreconditionFailed", "ErrorStack": "" }

...

Versions Compared

Old Version 32

New Version 33

Key

Update List

Read Lists

Remove recipients from a list - unsubscribe

Trust an email address

Get a trusted email address details

Disable an email address

Page Comparison

Versions Compared

Old Version 32

New Version 33

Key

Update List

Read Lists

Add recipients to a list - subscribe

Remove recipients from a list - unsubscribe

Trust an email address

Get a trusted email address details

Disable an email address