Sign in

v58

latestOpenAPI 3.0.3Apache 2.0raw.githubusercontent.com2026-08-036490116.2 KB
Portal Navigation Items

Update a portal navigation item

User must have the ENVIRONMENT_DOCUMENTATION[update] permission. ParentId is the unique identifier of the parent item.

  • Optional parent ID. If provided, the item is set to that parent.
  • If omitted, the item is moved to the root level.

Publication propagation applies only when the published value changes on a container navigation item (FOLDER, API, or API_PRODUCT). When publishing a container, descendants are published only if propagatePublishToChildren=true. If propagatePublishToChildren is omitted or false, only the selected item is published. When unpublishing a container, descendants are always unpublished according to the business rule; propagatePublishToChildren is ignored and may be omitted.

put/portal-navigation-items/{navId}

Path parameters

navIdstring required

The unique ID of the navigation item

Query parameters

propagatePublishToChildrenboolean

Controls whether publishing a container navigation item (FOLDER, API, or API_PRODUCT) is propagated to descendants. Only evaluated when published changes to true on a container item. If omitted or false, publishing affects only the selected item. If true, publishing also affects descendants. Ignored for unpublish; container descendants are always unpublished according to the business rule.

Request body

OR
OR
OR
OR

Example request

{
  "type": "FOLDER",
  "order": 2,
  "parentId": "00f8c9e7-78fc-4907-b8c9-e778fc790750",
  "published": true,
  "visibility": "PUBLIC",
  "source": {
    "type": "github-fetcher",
    "fetchCron": "0 */10 * * * *",
    "lastFetchedAt": "2026-07-17T00:00:00.000Z"
  }
}

Response

Updated portal navigation item

OR
OR
OR
OR

Example response

{
  "id": "00f8c9e7-78fc-4907-b8c9-e778fc790750",
  "organizationId": "DEFAULT",
  "environmentId": "DEFAULT",
  "type": "FOLDER",
  "area": "TOP_NAVBAR",
  "parentId": "00f8c9e7-78fc-4907-b8c9-e778fc790750",
  "rootId": "00f8c9e7-78fc-4907-b8c9-e778fc790750",
  "order": 2,
  "published": true,
  "visibility": "PUBLIC",
  "portalPageContentId": "00f8c9e7-78fc-4907-b8c9-e778fc790750",
  "source": {
    "type": "github-fetcher",
    "fetchCron": "0 */10 * * * *",
    "lastFetchedAt": "2026-07-17T00:00:00.000Z"
  }
}