v3

latestOpenAPI 3.0.22026-08-04424560.5 KB

Navigation

createNavigation

Create a new navigation configuration. Navigations are immutable and globally accessible across organizations. Each creation generates a new id. To update a navigation, create a new one.

post/v2/user/navigations

Request body

namestring required

Human-readable name for the navigation configuration

configurationNavigationConfiguration required

Navigation configuration organized by sections. Each section contains an array of navigation items.

Example request

{
  "name": "Sales Team Navigation",
  "configuration": {
    "customer_relations": [
      {
        "key": "dashboard"
      },
      {
        "key": "contact"
      }
    ],
    "configurations": [
      {
        "name": "Product Catalog",
        "subItems": [
          {
            "key": "product"
          },
          {
            "key": "price"
          }
        ]
      },
      {
        "key": "journey"
      }
    ]
  }
}

Response

Navigation created successfully

idstring nullable required

Navigation unique identifier - a hash of the normalized navigation payload (name + configuration). Identical navigations across orgs will have the same ID.

namestring required

Human-readable name for the navigation configuration

configurationNavigationConfiguration required

Navigation configuration organized by sections. Each section contains an array of navigation items.

Example response

{
  "id": "5gbe4nkp6jsfq",
  "name": "Sales Team Navigation",
  "configuration": {
    "customer_relations": [
      {
        "key": "dashboard"
      },
      {
        "key": "contact"
      }
    ],
    "configurations": [
      {
        "name": "Product Catalog",
        "subItems": [
          {
            "key": "product"
          },
          {
            "key": "price"
          }
        ]
      },
      {
        "key": "journey"
      }
    ]
  }
}