Portfolio

Core library Portfolio — file / portfolio items in Content Builder (init, add, retrieve, update, remove).

Portfolio manages portfolio file objects in the account (display name, file location, category, and so on).

Requires Platform.Load("core", "1.1.5") before use.

Methods

Method	Returns	Description
Portfolio.Init(key)	PortfolioInstance	Bind by external key
Portfolio.Add(properties)	string	Create a portfolio item
Portfolio.Retrieve(filter)	object[]	Query portfolio objects
<PortfolioInstance>.Update(properties)	string	Update the initialized item
<PortfolioInstance>.Remove()	string	Delete the item

---

Portfolio.Init

Initializes a Portfolio instance for the given external key.

Syntax

Portfolio.Init(key)

Parameters

Name	Type	Required	Description
key	string	Yes	External key of the portfolio item

Return value

PortfolioInstance

Examples

Platform.Load("core", "1.1.5");
var portObj = Portfolio.Init("myPortfolioCK");

---

Portfolio.Add

Creates a new portfolio item with the specified properties.

Syntax

Portfolio.Add(properties)

Parameters

Name	Type	Required	Description
properties	object	Yes	DisplayName, CustomerKey, CategoryID, FileName, FileLocation, …

Return value

"OK" on success.

Examples

Platform.Load("core", "1.1.5");
var newPortfolio = {
    DisplayName: "SSJS Portfolio Object",
    CustomerKey: "myPortfolioCK",
    CategoryID: 12345,
    FileName: "logo.png",
    FileLocation: "http://www.example.com/Portals/0/images/global/logo_main.png"
};
var status = Portfolio.Add(newPortfolio);

---

Portfolio.Retrieve

Queries portfolio items matching the given filter criteria.

Syntax

Portfolio.Retrieve(filter)

Parameters

Name	Type	Required	Description
filter	object	Yes	WSProxy-style filter

Return value

object[]

Examples

Platform.Load("core", "1.1.5");
var portObjArr = Portfolio.Retrieve({
    Property: "CustomerKey",
    SimpleOperator: "equals",
    Value: "PortfolioObjectKey"
});

---

<PortfolioInstance>.Update

Updates the initialized portfolio item with the given properties.

Syntax

<PortfolioInstance>.Update(properties)

Parameters

Name	Type	Required	Description
properties	object	Yes	Attributes to change

Return value

"OK" on success.

Examples

Platform.Load("core", "1.1.5");
var portObj = Portfolio.Init("myPortfolioCK");
var status = portObj.Update({ DisplayName: "Updated SSJS Image" });

---

<PortfolioInstance>.Remove

Removes the initialized portfolio item.

Syntax

<PortfolioInstance>.Remove()

Return value

"OK" on success.

Examples

Platform.Load("core", "1.1.5");
var portObj = Portfolio.Init("myPortfolioCK");
var status = portObj.Remove();