Page Comparison

On this page:

...

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/List

Reference

Go to automated doc

JSON request (example)

none

JSON response (example)

Expand

Code Block

language	html/xml

{
  "IsPaginated": false,
  "Items": [
    {
      "Company": "",
      "Description": "",
      "IdList": 23,
      "ListGuid": "2bb7ad3d-6f4f-4526-b35f-aea9e912097f",
      "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)

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

Retreive all the lists list(s) whose name contains exactly matches the string 'Newsletter' usingfilterby="Name.Contains(=='Newsletter')" and then sort them by ID with orderby="idList desc". Parameter names can be retreived from the response body. Please note that "Contains" filter matching is case sensitive.

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

Please note that also filtering with "Contains" is allowed but == is much more performing.

Old read lists method

Expand

title	DEPRECATED - Old read lists method

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

...

Description

Readgroups of specified list

HTTP Method

GET

URL

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

Reference

Go to automated doc

JSON request (example)

none

JSON response (example)

Expand

Code Block

language	html/xml

{"IsPaginated":false,"Items":[{"Deletable":true,"Name":"Test REST API Group","Notes":"I changed the notes again","idGroup":30,"idList":2},{"Deletable":true,"Name":"buddies","Notes":"","idGroup":27,"idList":2},{"Deletable":false,"Name":"Autoprofile","Notes":"Subscribers that changed their profile","idGroup":26,"idList":2},{"Deletable":false,"Name":"Subscribed from social network","Notes":"Subscribed with their social network account.","idGroup":25,"idList":2},{"Deletable":false,"Name":"TEST","Notes":"Used for test sending.","idGroup":24,"idList":2}],"PageNumber":0,"PageSize":20,"Skipped":0,"TotalElementsCount":5}

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/List/2/Groups?PageNumber=0&PageSize=5

Retreive all the groups whose name contains exactly matches the string 'Test' usingfilterby="Name.Contains('Test')" and then sort them by ID orderby="idGroup asc". Parameter names can be retreived from the response body. Please note that "Contains" filter matching is case sensitive.

https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/2/Groups?filterby="Name.Contains(==%27Test%27)"&orderby="idGroup+asc"

Please note that also filtering with "Contains" is allowed but == is much more performing.

Delete Group

Description	Deletea group starting from group ID
HTTP Method	DELETE
URL	https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{ID_LIST}/Group/{ID_GROUP}
Reference	Go to automated doc
JSON request (example)	none
JSON response (example)	none
Paging and filtering (example)	none

...

Versions Compared

Old Version 59

New Version 60

Key

Old read lists method

Remove recipients from a list - unsubscribe

Delete Group