---
title: "Replace Customization"
method: PUT
path: "/v3/portals/{portalId}/customization"
tags: ["Portal Customization"]
---

# Replace Customization

`PUT /v3/portals/{portalId}/customization`

Replace the portal customization options.

## Path parameters

- `portalId` string, uuid, required

## Request body

- PortalCustomizationV3 — The custom settings of this portal
  - `theme` object
    - `name` string
    - `mode` 'light' | 'dark' | 'system'
    - `colors` object
      - `primary` string
  - `layout` string
  - `css` string, nullable
  - `menu` object
    - `main` PortalMenuItem[]
      - `path` string, required — The absolute path of a page in a portal with a leading slash.
      - `title` string, required — The link display text
      - `visibility` 'public' | 'private', required — Whether a menu item is public or private. Private menu items are only accessible to authenticated users.
      - `external` boolean, required — When clicked, open the link in a new window
    - `footer_sections` PortalFooterMenuSection[]
      - `title` string, required — The footer menu section title
      - `items` PortalMenuItem[], required
        - `path` string, required — The absolute path of a page in a portal with a leading slash.
        - `title` string, required — The link display text
        - `visibility` 'public' | 'private', required — Whether a menu item is public or private. Private menu items are only accessible to authenticated users.
        - `external` boolean, required — When clicked, open the link in a new window
    - `footer_bottom` PortalMenuItem[]
      - `path` string, required — The absolute path of a page in a portal with a leading slash.
      - `title` string, required — The link display text
      - `visibility` 'public' | 'private', required — Whether a menu item is public or private. Private menu items are only accessible to authenticated users.
      - `external` boolean, required — When clicked, open the link in a new window
  - `spec_renderer` object
    - `try_it_ui` boolean — Enable in-browser testing for your APIs. All linked gateways must have the CORS plugin configured.
    - `try_it_insomnia` boolean — Enables users to open API specifications in Insomnia to explore and send requests with the native client. Only public API specifications are supported.
    - `infinite_scroll` boolean — Display the full spec on a single, scrollable page. If disabled, documentation, endpoints, and schemas appear on separate pages.
    - `show_schemas` boolean — Control whether schemas are visible in your API specs. When enabled, schemas appear in the side navigation below the endpoints.
    - `hide_internal` boolean — Manage visibility of internal endpoints and models.
    - `hide_deprecated` boolean — Manage visibility of deprecated endpoints and models.
    - `allow_custom_server_urls` boolean — Let users define a custom server URL for endpoints. This will be used to generate code snippets and to test the API. The URL is client-side only and is not saved.
  - `robots` string, nullable

## Response `200`

The current customization options for a portal.

- PortalCustomizationV3 — The custom settings of this portal
  - `theme` object
    - `name` string
    - `mode` 'light' | 'dark' | 'system'
    - `colors` object
      - `primary` string
  - `layout` string
  - `css` string, nullable
  - `menu` object
    - `main` PortalMenuItem[]
      - `path` string, required — The absolute path of a page in a portal with a leading slash.
      - `title` string, required — The link display text
      - `visibility` 'public' | 'private', required — Whether a menu item is public or private. Private menu items are only accessible to authenticated users.
      - `external` boolean, required — When clicked, open the link in a new window
    - `footer_sections` PortalFooterMenuSection[]
      - `title` string, required — The footer menu section title
      - `items` PortalMenuItem[], required
        - `path` string, required — The absolute path of a page in a portal with a leading slash.
        - `title` string, required — The link display text
        - `visibility` 'public' | 'private', required — Whether a menu item is public or private. Private menu items are only accessible to authenticated users.
        - `external` boolean, required — When clicked, open the link in a new window
    - `footer_bottom` PortalMenuItem[]
      - `path` string, required — The absolute path of a page in a portal with a leading slash.
      - `title` string, required — The link display text
      - `visibility` 'public' | 'private', required — Whether a menu item is public or private. Private menu items are only accessible to authenticated users.
      - `external` boolean, required — When clicked, open the link in a new window
  - `spec_renderer` object
    - `try_it_ui` boolean — Enable in-browser testing for your APIs. All linked gateways must have the CORS plugin configured.
    - `try_it_insomnia` boolean — Enables users to open API specifications in Insomnia to explore and send requests with the native client. Only public API specifications are supported.
    - `infinite_scroll` boolean — Display the full spec on a single, scrollable page. If disabled, documentation, endpoints, and schemas appear on separate pages.
    - `show_schemas` boolean — Control whether schemas are visible in your API specs. When enabled, schemas appear in the side navigation below the endpoints.
    - `hide_internal` boolean — Manage visibility of internal endpoints and models.
    - `hide_deprecated` boolean — Manage visibility of deprecated endpoints and models.
    - `allow_custom_server_urls` boolean — Let users define a custom server URL for endpoints. This will be used to generate code snippets and to test the API. The URL is client-side only and is not saved.
  - `robots` string, nullable

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found

---

[API](https://skmtc.net/kong/apis/konnect-api-go-sdk.md) · [All operations](https://skmtc.net/kong/apis/konnect-api-go-sdk/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kong/konnect-api-go-sdk/versions/0261aef4b1e2/schema)