Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

Overview

MailUp allows you to push content from an external source, in order to use it for triggering automatic campaigns or to simplify the message creation process. For example, in case of email messages the pushed items will be available in the right pane of your Bee email editor, ready to be dragged into to your email message.

What is a content?

MailUp accepts objects that match a predefined format and renders them for automated campaigns or inside the Bee editor. As an API client, all you have to do is to map your information set into the supported fields for MailUp content management.

 Click here to check the supported content fields ...

The Fields in bold are mandatory

FieldDescriptionFormat
Titlecontent titleString
Summarycontent short descriptionString
SubTitlecontent subtitleString
Imagelink of the image, hosted on your website, to be retrievedURL (full path)
LinkURLmain URL, where is the content itselfURL (full path)
LinkTexttext in the URLString
ContentDatepublishing date or a date you want to associate to the contentISO (e.g. "2018-08-14 11:27:23Z")
ContentKey

unique keyword to identify each content (it can be used to update an existing content or in the search bar in the page View contents)

String (e.g. a GUID)
Categorieslist of categories related to the contentArray of comma separated items
Authorslist of authorsArray of comma separated items

Why do I need to set a source for content pushed through API?

Automated campaigns are based on source updates, then you have to set a source for each content you push into MailUp. Even if you are not using automation, grouping by source is helpful when it comes to search or manage content using MailUp web application.

How can I build an automated campaign?

At the moment the automated campaigns cannot be set using API. You need to use the MailUp web application. Please refer to Campaigns on the user guide

 

 

Table of Contents

Sources

Add a new source

Description

Create a new source.

A source created using API is automatically visible on all MailUp lists and to all the users who have access to the Content area on the web application

HTTP Method

POST
URL
JSON request (example)

SourceName is the text displayed on the web application. It does not have to be unique and you can change it later

IsEnabled should be set to false if you want to avoid automatic campaigns to be triggered when this source is updated

{
	"SourceName": "mySource",
	"IsEnabled": true
}
JSON response (example)An error is returned if you set a null or empty SourceName.
Paging and filtering (example)

 

Get all available sources

DescriptionRead all the available sources
At the moment there is not a method to filter by source name. You need to retrieve a list of items and parse it

HTTP Method

GET
URL
https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/ContentProvider/Sources
JSON request (example)

none

JSON response (example) 
Paging and filtering (example)

Pagination

GET /Console/ContentsProvider/Sources?pageSize={max_items} to limit the number of returned items.

GET /Console/ContentsProvider/Sources?pageSize=1&pageNumber=1&orderby="UpdateDate ASC" to get the last modified item

Sorting

GET /Console/ContentsProvider/Sources?orderby="CreationDate DESC" you can sort by any of the parameters contained in the response object


Update a source

DescriptionUpdate a source by changing its name or its status

HTTP Method

PUT
URL
https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/ContentProvider/Sources/{source_id}
JSON request (example)

SourceName has to be unique. An error is returned if you leave it null or empty

{
	"SourceName": "mySource",
	"IsEnabled": true
}
JSON response (example)
none
Paging and filtering (example)

 


Remove a source

DescriptionDelete a source

HTTP Method

DELETE
URL
https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/ContentProvider/Sources/{source_id}
JSON request (example)

none

JSON response (example)
HTTP 400 (Bad Request) is returned if the source to be deleted is set to trigger an automatic campaign.
When this occurs, you have remove all the campaigns related to this source (requires access to the web application)
Paging and filtering (example)

 


Content

Upload content

DescriptionUpload one or more content items

HTTP Method

POST
URL
https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/ContentProvider/Sources/{source_id}/Content
JSON request (example)
 Click here to expand...

Use UploadMode = 2 (incremental)

Please note that "Items" is an array of comma separated values. With a single API call you can upload more content items. In case of bulk upload, any automated campaign related to the source is triggered once at the end of the whole process.

ContentKey is a mandatory tag that informs MailUp if you are providing a new content or if you want to upload an existing one.

Refer to the collapsed table on the top of this page for a list of all supported tags.

{
	"UploadMode": 2,
	"Items": [{
		"ContentKey":"966ec9fd-d40b-47db-b4bb-d3be14bbc14b",
		"Image":"https://i.imgur.com/3Z5NaFI.jpg",
		"Authors":["Cicero","H. Rackham"],
		"LinkURL":"http://www.example.com",
		"LinkText":"This is an example",
		"Summary":"Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s.",
		"Title":"Lorem ipsum",
		"Categories":["dummy","text"],
		"SubTitle":"Lorem ipsum dolor sit amet, consectetur adipiscing elit."
	}]
}

 

 
JSON response (example) 
Paging and filtering (example)

 


Get content list

DescriptionRetrieve a list of content related to a source

HTTP Method

GET
URL
https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/ContentProvider/Sources/{source_id}/Content
JSON request (example)

none

JSON response (example) 
Paging and filtering (example)

 


Remove content

DescriptionDelete content

HTTP Method

DELETE
URL
https://services.mailup.com/API/v1.1/Rest/ConsoleService.svc/Console/ContentProvider/Sources/{source_id}/Content/{{CONTENT_KEY}}
JSON request (example)

none

JSON response (example) 
Paging and filtering (example)

 


  • No labels