Sign in
Portal Customization

Get Customization

Returns the portal customization options.

get/v3/portals/{portalId}/customization

Path parameters

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

The Portal identifier

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

Changed in 3 of the 30 revisions of this API.410

  • 658ffb748f951See the full diff
    • ○

      added the optional property to the response with the status

      response-optional-property-added

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

  • ecce2daf9de647See the full diff
    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ▲

      the response property / became nullable for the status

      response-property-became-nullable

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

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

      response-property-default-value-added

    • ○

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

      response-property-default-value-added

    • ○

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

      response-property-default-value-added

    • ○

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

      response-property-default-value-added

    • ○

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

      response-property-default-value-added

    • ○

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

      response-property-default-value-added

  • b2800570b3e22See the full diff
    • ○

      added the optional property / to the response with the status

      response-optional-property-added

    • ○

      added the optional property / to the response with the status

      response-optional-property-added

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