Portal Customization

Update Customization

Changed on

Update the portal customization options, merging properties.

patch/v3/portals/{portalId}/customization

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v3/portals/{portalId}/customization
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Path parameters

portalIdstring uuid required
Example:f32d905a-ed33-46a3-a093-d8f536af9a8a

ID of the portal.

Request body

layoutstring

This property is deprecated and is not used by the portal.

cssstring nullable
robotsstring nullable

Example request

{
  "theme": {
    "colors": {
      "primary": "#000000"
    }
  },
  "menu": {
    "main": [
      {
        "path": "/about/company",
        "title": "My Page",
        "visibility": "public"
      }
    ],
    "footer_sections": [
      {
        "items": [
          {
            "path": "/about/company",
            "title": "My Page",
            "visibility": "public"
          }
        ]
      }
    ],
    "footer_bottom": [
      {
        "path": "/about/company",
        "title": "My Page",
        "visibility": "public"
      }
    ]
  }
}

Response

The current customization options for a portal.

layoutstring

This property is deprecated and is not used by the portal.

cssstring nullable
robotsstring nullable

Example response

{
  "theme": {
    "colors": {
      "primary": "#000000"
    }
  },
  "menu": {
    "main": [
      {
        "path": "/about/company",
        "title": "My Page",
        "visibility": "public"
      }
    ],
    "footer_sections": [
      {
        "items": [
          {
            "path": "/about/company",
            "title": "My Page",
            "visibility": "public"
          }
        ]
      }
    ],
    "footer_bottom": [
      {
        "path": "/about/company",
        "title": "My Page",
        "visibility": "public"
      }
    ]
  }
}

Changes

  • 7aab863a6daaRevision changes
    • breaking

      added to the / response property oneOf list for the response status

    • warning

      added the new key_invalid enum value to the ////// response property for the response status

    • warning

      added the new unique enum value to the ////// response property for the response status

    • info

      added the new optional request property /

    • info

      added the optional property / to the response with the status

  • 59663dd13a10Revision changes
    • info

      the request property default value ocean was added

    • info

      request property deprecated

    • info

      the response's property default value ocean was added for the status

    • info

      response property layout deprecated