Skip to main content

Portfolio alias and connected portfolios

The portfolio object now has two new fields: alias, a nickname defined by your organization, and connected, which indicates whether the portfolio belongs to someone else and was shared with your organization.

Both fields are returned by endpoints such as List Portfolios and Read Portfolio by ID:

  • connected: true when the portfolio was shared with (connected to) your organization and is not owned by it.
  • alias: the nickname your organization gives the portfolio, or null when there is none. The original name (name) does not change, and the portfolio's owner does not see the alias.

The alias is useful, for example, to identify connected portfolios with your organization's internal codes. To set, change or remove it, use Update Portfolio by ID, sending alias with the new value or null:

{
  "alias": "ID-0042"
}

Learn more in Portfolio.