Sign in
Portal Customization

Replace Customization

Replace the portal customization options.

put/v3/portals/{portalId}/customization

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"
      }
    ]
  }
}

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"
      }
    ]
  }
}

Changes

Changed in 4 of the 52 revisions of this API.213

  • 19e869275e281See the full diff
    • ●

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

      response-property-enum-value-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • dcc482e2b1ee2See the full diff
    • ▲

      the request property became not nullable

      request-property-became-not-nullable

    • ▲

      the request property / became not nullable

      request-property-became-not-nullable

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 44bb2f5730c42See the full diff
    • ○

      added the new optional request property /

      new-optional-request-property

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

  • 96118a9cd7f41See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog