Manage Portal Settings
This section describes how to configure a portal instance via its administrative APIs. The portal settings control branding, name, domain URL, and availability. These settings are categorized into general, branding, and landingPage.
Portal Settings Table
| Level | Setting Name | Description |
|---|---|---|
| general | name | The name of the portal instance. |
| general | subdomain | The subdomain used in your portal URL. |
| general | offline | Marks portal as offline and inaccessible to customers. |
| branding | faviconId | Reference to favicon (16x16 .ico/.gif/.png under 5MB). |
| branding | logoId | Reference to logo (64x64 .jpg/.gif/.png under 5MB). |
| branding | fontName | Font used in portal (e.g., Roboto, Lato). |
| branding | accentColor | Hex color for branding. |
| landingPage | heroImageId | Reference to hero image (max 566x80 px .jpg/.png). |
| landingPage | illustrationImageId | Reference to illustration (min 566x320 px, 16:9, .jpg/.png). |
| landingPage | pageDescription | Markdown-supported landing page description (max 500 characters). |
Retrieve Base Portal Info
Use the GET Get portal endpoint to retrieve your current configuration.
Sample Response
📝 Keep this response handy. You’ll need values like
portalIdfor image uploads and updates.
Upload Branding Images
Use the POST upload branding attachments endpoint to upload images.
Update Portal Settings
Use the PATCH portal endpoint to apply configuration changes.