Update a folder

This route allows you to update a folder in a sidebar. You can change its title, identifier, or position within the sidebar hierarchy.<br/><br/>To learn more about folders, check out the documentation.

patch/v1/sidebars/{sidebar_identifier}/folders/{folder_identifier}

Request

Base URL: https://api.port.io
URL: https://api.port.io/v1/sidebars/{sidebar_identifier}/folders/{folder_identifier}
Auth: API key in header Authorization

Path parameters

sidebar_identifier'catalog' required

The identifier of the sidebar. Currently only catalog is supported.

folder_identifierstring required

The identifier of the folder to operate on.

Request body

identifierstring

The unique identifier of the folder.

titlestring

The display title of the folder.

iconstring nullable

The display icon of the folder.

parentstring nullable

The identifier of the parent folder. Use null to place the folder at the root level of the sidebar.

afterstring nullable

The identifier of the sibling item after which this folder should appear. Use null to place the folder at the beginning of its parent.

Response

Updated successfully.

okunknown required

Changes

No recorded changes to this operation across all 1 revision of this API.