Versions Compared

Old Version 50

changes.mady.by.user MailUp Dev Team

Saved on

compared with

New Version 51

changes.mady.by.user MailUp Dev Team

Saved on

Key

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

On this page:

...

DescriptionDelete an existing list
HTTP MethodDELETE
URLhttps://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}
ReferenceGo 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
languagebash
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-macthmatch: 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)

 

...

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

...