Page Comparison

On this page:

...

Expand

title	Old API method to update an existing 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 deprecated 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",
   "CompanyName": "Your company name",
   "ContactName": "Your contact reference",
   "Address": "Your address",
   "City": "Your city",
   "CountryCode": "IT",
   "PermissionReminder": "Your permission reminder",
   "Phone": "Your phone number",
   "PostalCode": "26100",
   "StateOrProvince": "Cremona",
   "WebSiteUrl": "Your site"
}

Paging and filtering (example)

Delete List

Description

Delete an existing list

HTTP Method

DELETE

URL

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

Reference

Go to automated doc

JSON request (example)

To ensure your intention to delete the list, we need to know 2 list-related values:

put the list identifier (id_List) into the resource url
add the If-Match header and set its value to the ListGuid value

Code Block

language	bash

curl -X DELETE 
	 https://services.mailup.com/api/v1.1/rest/ConsoleService.svc/Console/List/{id_List}
     -H 'authorization: Bearer {access_token}'   
     -H 'if-match: {ListGuid}'

JSON response (example)

if list succesfully deleted
Code Block
empty

if IF-MATCH header missing

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

if IF-MATCH contains a wrong value (i.e., if-macth: aaaa)

Code Block
412 PreconditionFailed { "ErrorCode": "412", "ErrorDescription": "If-Match header content type must be: System.Guid.", "ErrorName": "PreconditionFailed", "ErrorStack": null }

if IF-MATCH contains a value that does not match to provided id_list

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

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

...

Versions Compared

Old Version 49

New Version 50

Key

Delete List

Read Lists

Remove recipients from a list - unsubscribe

Page Comparison

Versions Compared

Old Version 49

New Version 50

Key

Delete List

Read Lists

Add recipients to a list - subscribe

Remove recipients from a list - unsubscribe