Page tree

Versions Compared

Key

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

...

Tip

...

 

Subscribers

 

Email messages

 

Statistics

...

title
How to get account info
DescriptionReturns profile info for authenticated user account
HTTP MethodGET
URLhttps://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/Authentication/Info
JSON request parameters (example)none
JSON response (example){"Company":"nweb srl","IsTrial":true,"UID":"388","Username":"m1234","Version":"8.5"}
Paging and filtering (example)none

 

How to create a console account

 

Lists and groups

How to get available lists

Note: methods for creating new lists through REST API are not yet available

DescriptionReturn the lists that are visible for authenticated user
HTTP MethodGET
URLhttps://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/User/Lists
JSON request (example)none
JSON response (example)
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"
How to manage groups

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

DescriptionCreate a group into the specified list. Group ID is returned
HTTP MethodPOST
URLhttps://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{ID_LIST}/Group
JSON request (example)
Code Block
languagehtml/xml
{
                "Deletable":true,
                "Name":"Test REST API Group",
                "Notes":"Notes should go here",
                "idList":2
}
JSON response (example)
Code Block
languagehtml/xml
{"Deletable":true,"Name":"Test REST API Group","Notes":"Notes should go here","idGroup":30,"idList":2}
Paging and filtering (example)

none

...

Code Block
languagehtml/xml
{
                "Deletable":true,
                "Name":"Test REST API Group",
                "Notes":"I changed the notes again",
				"idGroup":30,
                "idList":2
}

...

Code Block
languagehtml/xml
{"Deletable":true,"Name":"Test REST API Group","Notes":"I changed the notes again","idGroup":30,"idList":2}

...

none

...

none

...

Code Block
languagehtml/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}

...

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 'Test' filterby="Name.Contains('Test')" and sort them by ID orderby="idGroup asc". 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/List/2/Groups?filterby="Name.Contains(%27Test%27)"&orderby="idGroup+asc"
New to MailUp?

 We recommend to first take a peak at our Code Samples to familiarize with our API.

API resources organized by topic

The following pages show you how to access the many resources made available by the MailUp REST API:

Children Display
alltrue

 

...

In-depth technical details1

(1) only for expert users

 

...

More about MailUp REST API