---
title: "Create portal menu link"
method: POST
path: "/ui/portal-menu-links"
tags: ["Management UI"]
---

# Create portal menu link

`POST /ui/portal-menu-links`

## Request

- Base URL: `/management/v2/environments/DEFAULT` (relative, and the document was published on a file host, not at the API’s origin)
- URL: `/management/v2/environments/DEFAULT/ui/portal-menu-links`
- Auth: none declared

Create a new portal menu link.
For an EXTERNAL link, provide a name and a target.

User must have the ENVIRONMENT_SETTINGS[UPDATE] permission.

## Request body

- CreatePortalMenuLink
  - `name` string, required: Displayed name of the menu link
  - `type` 'EXTERNAL', required: type of the menu link
  - `target` string: target of the menu link
  - `visibility` 'PUBLIC' | 'PRIVATE': visibility of the menu link

## Response `201`

The created portal menu link

- PortalMenuLink
  - `id` string, required: Portal menu link id
  - `name` string, required: Displayed name of the menu link
  - `type` 'EXTERNAL', required: type of the menu link
  - `target` string: target of the menu link
  - `visibility` 'PUBLIC' | 'PRIVATE': visibility of the menu link
  - `order` integer, required: The order of the menu link.

## Other responses

- `default`: Generic error response

## Changes

- **2024-08-30** `3375d6eeea70`: 2 info
  - added the new optional request property `visibility`
  - added the optional property `visibility` to the response with the `201` status
- **2024-08-26** `0bfd3b0b2723`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/gravitee-io/apis/gravitee-io-apim-management-api-ui/changes/ui/portal-menu-links/post.md)

---

[API](https://skmtc.dev/gravitee-io/apis/gravitee-io-apim-management-api-ui.md) - [All operations](https://skmtc.dev/gravitee-io/apis/gravitee-io-apim-management-api-ui/llms.txt) - [OpenAPI document](https://skmtc.dev/gravitee-io/apis/gravitee-io-apim-management-api-ui/revisions/6e3899b14406?raw)