Versions Compared

Key

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

...

DescriptionModify an existing message

HTTP Method

PUT

URL

Code Block
https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Email/{id_Message}

JSON request (example)

Request data format is the same as the response of "GET /Console/List/{id_List}/Email/{id_Message}"

Expand
Code Block
{"Subject":"Annual Newsletter n.9","idList":2,"Content":"<table><tbody><tr><td><strong>Image<\/strong>&nbsp;<\/td><td><strong>Text<\/strong>&nbsp;<\/td><\/tr><tr><td style=\"width: 200px; height: 70px;\">&nbsp;<img src=\"http:\/\/d0i4f.s57.it\/images\/2\/ListImages\/sociallogin.PNG\" alt=\"This text is visible if you do not see images\" title=\"SocialLogin\" longdesc=\"Social Login Image\" width=\"200\" height=\"70\" ><\/td><td>&nbsp;This screenshot shows you how to perform login with social networks<br>&nbsp;(see <a href=\"http:\/\/[track]\/https:\/\/help.mailup.com\" target=\"_blank\" id=\"User\" s=\"\" manual'=\"\">manual<\/a>)&nbsp;<\/td><\/tr><\/tbody><\/table>","Embed":false,"IsConfirmation":false,"Notes":"Issue n. 9 June 2014","Tags":[],"TrackingInfo":{"CustomParams":"","Enabled":true,"Protocols":["http:","ftp:","news:"]}}

JSON response (example)

Code Block
{"Subject":"Monthly Newsletter!","idList":2,"idMessage":24}

Paging and filtering (example)

none

...

DescriptionRead available tags for a specified list

HTTP Method

GET, POST, PUT, DELETE

URL

Retrieve list tags:

Code Block
GET https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Tags

Create a new tag:

Code Block
POST https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Tag

Modify a tag:

Code Block
PUT https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Tag/{id_Tag}

Remove a list tag:

Code Block
DELETE https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Tag/{id_Tag}

JSON request (example)

  • No request body is required for GET and DELETE methods
  • POST method requires a simple string as parameter (e.g. "my-new-tag"), not a JSON structure
  • PUT method requires a full structure like {"Enabled":true,"Id":6,"Name":"my-new-tag"}

JSON response (example)

GET method returns the retrieved tags list

Expand
Code Block
{"IsPaginated":false,"Items":[{"Enabled":true,"Id":5,"Name":"news"},{"Enabled":true,"Id":4,"Name":"users-manual"},{"Enabled":true,"Id":3,"Name":"$5 off promo"},{"Enabled":true,"Id":2,"Name":"preferred customer"},{"Enabled":true,"Id":1,"Name":"promotion"}],"PageNumber":0,"PageSize":20,"Skipped":0,"TotalElementsCount":5}


POST and PUT methods return the full structure of the created/updated tag, e.g.  {"Enabled":true,"Id":6,"Name":"my-new-tag"}

An empty response is returned by DELETE method

Paging and filtering (example)

none

...

Example: POST /Console/List/2/Email/30/Send?datetime='"2014-10-20 05:00:00Z'"

 

Note

Message sending fails with HTTP 500 error if no authorized sender email nor sender email are provided. Ensure that sender name and sender email have been configured at list level (starting from MailUp version 8.6.1 the sender address has also to be a verified address)

...