Versions Compared

Old Version 51

changes.mady.by.user MailUp Dev Team

Saved on

compared with

New Version 52

changes.mady.by.user MailUp Dev Team

Saved on

Key

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

On this page:

Table of Contents

...

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/ListsList
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"idList":2,"listGuid 23,
      "ListGuid": "f34e50542bb7ad3d-55556f4f-44444526-ffffb35f-51acc36ae104aea9e912097f"},
{"Company
      "Name": "New Arrivals"
    },
    ...
    {
      "Company": "",
      "Description": "Iscritti alla newsletter. Si possono creare infinite liste, ad esempio per tipologie di newsletter, per società...",
      "IdList": 1,
      "ListGuid": "aafa5375-bcf1-4e06-965a-e3a98b626156",
      "Name": "Newsletter"
    }
  ],
  "PageNumber": 0,
  "PageSize": 20,
  "Skipped": 0,
  "TotalElementsCount": 6
}
Paging and filtering (example)

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

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.

Old read lists method

Expand
titleOld read lists method
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)

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.

...

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

...