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

# Create portal menu link

`POST /ui/portal-menu-links`

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

---

[API](https://skmtc.net/gravitee-io/apis/gravitee-io-apim-management-api-ui.md) · [All operations](https://skmtc.net/gravitee-io/apis/gravitee-io-apim-management-api-ui/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gravitee-io/gravitee-io-apim-management-api-ui/revisions/6e3899b14406/schema)