Update a portfolio
Renames a portfolio and replaces its icon list. Both values are written as given, so omitting icons clears them.
Authorization
AuthorizationstringrequiredBearer token — Send your API token in the Authorization header as Bearer <token>. Requests without a valid token are rejected with 401 Unauthorized.
Path parameters
portfolioIdstringrequiredSnowflake id of the portfolio, as a decimal string.
example: 1830472847398404096
Body
application/json
The whole portfolio is written from this body — there is no partial update.
namestringrequiredThe new name. Up to 150 characters, and it must not be blank. Leading and trailing spaces are trimmed.
iconsstring[]Replaces the icon list. Leave it out and the list is emptied.
Response
200 · The updated portfolio, without the `properties` array.
idstringSnowflake id of the portfolio.
activebooleanfalse once the portfolio has been deactivated.
namestringThe portfolio's name.
propertyCountintegerHow many properties sit in the portfolio, active and deactivated together.
iconsstring[]Icon keys pinned to the portfolio. Free-form strings; they are added and removed through the icons endpoints, not here.