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 2 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 ...
FieldDescription
Titlecontent title
Summarycontent short description
Imagelink of the image, hosted on your website, to be retrieved
LinkURLmain URL, where is the content itself
LinkTexttext in the URL
ContentDatepublishing date or a date you want to associate to the content
ContentKeykeyword to identify each content (it can be used to update an existing content or in the search bar in the page View contents)

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 or 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
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)

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

Remove a source

Content

Upload content

Get content list

Remove content

  • No labels