Portal Customization

Replace Customization

Changed on

Replace the portal customization options.

put/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

The Portal identifier

Request body

layoutstring
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"
      }
    ]
  },
  "portal_layout": {
    "footer": {
      "snippet_name": "my-snippet"
    }
  }
}

Response

The current customization options for a portal.

layoutstring
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"
      }
    ]
  },
  "portal_layout": {
    "footer": {
      "snippet_name": "my-snippet"
    }
  }
}

Changes

  • 658ffb748f95Revision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

  • 5d2b35832e3fRevision changes
    • warning

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