Versions Compared

Old Version 48

changes.mady.by.user MailUp Dev Team

Saved on

compared with

New Version 49

changes.mady.by.user MailUp Dev Team

Saved on

Key

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

On this page:

...

DescriptionUpdate an existing list
HTTP MethodPUT
URLhttps://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List_ID}
Reference

Go to automated doc 

For details about parameters you can look at Create List method.

JSON request (example)
Expand
Code Block
languagejs
{
  "Name": "NEW LIST NAME",
  "Description": "I ADDED THIS FEW LINES TO DESCRIBE THE PURPOUS OF THIS LIST",
  "CompanyName": "Your MODIFIED company NAME",
  "WebSiteUrl": "My NEW site",
  "BouncedEmail": null,
  "Charset": "UTF-8",
  "ConversionlabTrackCode": "",
  "DefaultPrefix": "0039",
  "Disclaimer": "Per l'informativa sulla privacy D.Lgs 196/2003 visitare l'home page del sito. <br/> Policy AntiSPAM garantita da <a href=\"http://www.mailup.it/email-marketing/policy-antispam.asp\" target=_blank><img src=\"http://doc.mailupnet.it/logo_small_R.gif\" border=\"0\" align=\"middle\" /></a>",
  "Format": "html",
  "FrontendForm": true,
  "HeaderListUnsubscriber": "<[listunsubscribe]>,<[mailto_uns]>",
  "HeaderXAbuse": "Please report abuse here:  http://www.mailup.it/email-marketing/Policy-antispam_ENG.asp",
  "KBMax": 100,
  "LinkTrackingParameters": "",
  "MultiOptoutList": "21",
  "MultipartText": true,
  "NotifyEmail": null,
  "OptoutType": 3,
  "Public": true,
  "ScopeCode": 0,
  "SendConfirmSms": false,
  "SendEmailOptout": false,
  "SmsSenderName": "",
  "SubscribedEmail": true,
  "TimeZoneCode": "UTC+01:00.0",
  "TrackOnOpened": true,
  "Address": "Your address",
  "Business": true,
  "City": "Your city",
  "ContactName": "Your name",
  "CountryCode": "IT",
  "Customer": true,
  "DisplayAs": "Your sender name",
  "NLSenderName": "Your list name",
  "OwnerEmail": "jane@example.com",
  "PermissionReminder": "Your permission reminder",
  "Phone": "",
  "PostalCode": "",
  "ReplyTo": "mike@example.com",
  "StateOrProvince": ""
}
JSON response (example)
Expand
Code Block
languagehtml/xml
{
  "BouncedEmail": null,
  "Charset": "UTF-8",
  "ConversionlabTrackCode": "",
  "DefaultPrefix": "0039",
  "Description": "I ADDED THIS FEW LINES TO DESCRIBE THE PURPOUS OF THIS LIST",
  "Disclaimer": "Per l'informativa sulla privacy D.Lgs 196/2003 visitare l'home page del sito. <br/> Policy AntiSPAM garantita da <a href=\"http://www.mailup.it/email-marketing/policy-antispam.asp\" target=_blank><img src=\"http://doc.mailupnet.it/logo_small_R.gif\" border=\"0\" align=\"middle\" /></a>",
  "Format": "html",
  "FrontendForm": true,
  "HeaderListUnsubscriber": "<[listunsubscribe]>,<[mailto_uns]>",
  "HeaderXAbuse": "Please report abuse here:  http://www.mailup.it/email-marketing/Policy-antispam_ENG.asp",
  "KBMax": 100,
  "LinkTrackingParameters": "",
  "MultiOptoutList": "21",
  "MultipartText": true,
  "NotifyEmail": null,
  "OptoutType": 3,
  "Public": true,
  "ScopeCode": 0,
  "SendConfirmSms": false,
  "SendEmailOptout": false,
  "SmsSenderName": "",
  "SubscribedEmail": true,
  "TimeZoneCode": "UTC+01:00.0",
  "TrackOnOpened": true,
  "Address": "Your address",
  "Business": true,
  "City": "Your city",
  "CompanyName": "Your MODIFIED company NAME",
  "ContactName": "Your name",
  "CountryCode": "IT",
  "Customer": true,
  "DisplayAs": "Your sender name",
  "IdList": 21,
  "ListGuid": "1239a201-47d1-46fa-b5a1-384ad6e78c60",
  "NLSenderName": "Your list name",
  "Name": "NEW LIST NAME",
  "OwnerEmail": "jane@example.com",
  "PermissionReminder": "Your permission reminder",
  "Phone": "",
  "PostalCode": "",
  "ReplyTo": "mike@example.com",
  "StateOrProvince": "",
  "WebSiteUrl": "My NEW site"
}
Paging and filtering (example) 

...

DescriptionReturn 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 MethodGET
URLhttps://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/User/Lists
ReferenceGo to automated doc
JSON request (example)none
JSON response (example)
Expand
Code Block
languagehtml/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 recipients to a list - subscribe

...

  • 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

...