PORTALCONFIG: Portal Configuration
The PORTALCONFIG entity represents configuration record for a customer-facing portal. Each subscription can have multiple portals, each with its own subdomain and type (IT Support, Contractor, etc.).
Default definition. This article describes the default
PORTALCONFIG definition shipped with DemandFlow. Administrators can add, remove, rename, or re-type fields, change which ones are required, and alter the layout from the Definitions screen in Settings. Your tenant's current schema may differ from what is shown here. To read the current definition at any time, GET the DEFINITION object whose id matches PORTALCONFIG.Entity properties
| Property | Value |
|---|---|
| Entity code | PORTALCONFIG |
| Display name | Portal Configuration |
| Plural | Portal Configurations |
| Level | 60000 |
Use cases
PORTALCONFIG is managed via the Portal Settings page (settings_portal.js). Multiple records per subscription are supported, each with a unique subdomain. The portalType field determines which features are available. The subdomain field maps to {subdomain}.portal.demandflow.com. The portal rendering Lambda reads this record to build the public site. logoKey references an S3 file uploaded via api.uploadFile.
Fields
General
| Field | Type | Required | Notes |
|---|---|---|---|
portalType | enum | Yes | Portal Type. Valid ids: 1 (IT Support), 2 (Contractor). |
name | text | Yes | Portal Name. |
subdomain | text | Yes | Your portal will be available at {subdomain}.portal.demandflow.com. |
portalTitle | text | Displayed as the main heading on the portal. | |
portalDescription | text (multi-line) | Shown on the portal homepage. | |
supportEmail | text | Contact email displayed on the portal. | |
primaryColor | text | Hex colour code for portal header and accents. | |
logoKey | text | S3 key for the uploaded logo (managed via Portal Settings page). Read-only. | |
enabled | boolean | Enable or disable the public portal. | |
portalUserAccountsEnabled | boolean | Allow portal visitors to create accounts and log in. | |
knowledgeBaseEnabled | boolean | Allow visitors to browse public knowledge base articles. | |
ticketSubmissionEnabled | boolean | Allow visitors to submit support tickets. | |
captchaEnabled | boolean | Require CAPTCHA verification on ticket submission. | |
timesheetEnabled | boolean | Allow contractors to submit timesheets. | |
expenseEnabled | boolean | Allow contractors to submit expenses. | |
invoiceEnabled | boolean | Allow contractors to submit invoices. |
Legal
| Field | Type | Required | Notes |
|---|---|---|---|
privacyPolicy | text (multi-line) | HTML or plain text content for the Privacy Policy page on the public portal. | |
termsOfUse | text (multi-line) | HTML or plain text content for the Terms of Use page on the public portal. |
Relationships
- Related lists:
PORTALUSERvia formatSUB|PORTAL.
Creating a Portal Configuration via the API
POST /v1/objects
Authorization: Bearer <your-pat>
Content-Type: application/json
{
"entity": "PORTALCONFIG",
"level": 60000,
"comboKey": "SUB:<your-sub-id>|ENT:",
"portalType": "1",
"name": "Example",
"subdomain": "Example text",
"portalTitle": "Example text"
}Listing PORTALCONFIG records
# All portal configurations in your tenant
GET /v1/entities/PORTALCONFIG/SUB