#Tenant Settings
| Role | Access Level |
|---|---|
| Client Admin | Edit |
| Client Manager | View only |
| Client Staff | No section |
#Overview
Tenant Settings let you review and manage organisation-level display preferences and contact details for your tenant. The current portal section covers display timezone, regional format, billing contact, security contact, and an optional branding display name.
This section does not upload logos or change visual assets. Logo and wider brand asset changes are outside the current Tenant Settings workflow.
#Prerequisites
- You are signed in to the AiDial portal. See Signing In for instructions.
- Client Admins can edit tenant settings. This section is not shown in the visible Client Admin Settings navigation; open it with the direct route
/settings?section=tenant-settings. - Client Managers can review tenant settings in a read-only summary view from their Settings navigation.
- Client Staff do not receive this Settings section.
- Your tenant must be active. Tenant settings are tenant-scoped and do not require a project selector.
#Updating Tenant Settings
- Select Settings from the sidebar.
- Open the Tenant Settings section using the direct route
/settings?section=tenant-settings. Client Admins do not see a Tenant Settings entry in the visible Settings navigation, so use this link. Client Managers open the read-only Tenant Settings summary from their Settings navigation or the same route. - Review the current timezone, regional format, billing contact, security contact, branding display name, and last-changed details.
- If the section is editable, select Edit.
- Update the required values and any optional contact or branding fields. The form checks each field when you save and shows inline messages next to any value it rejects.
- Select Save to submit your changes, or Cancel to discard unsaved edits.
#Access, Scope, and Save Behaviour
The browser uses your signed-in portal session and calls the portal route /api/settings/tenant-settings. You do not need to enter an API key, and the browser must not send X-API-Key for this workflow.
The portal server forwards your session bearer token to aidial_api at /v1/tenant-settings. Reads are available to Client Admins and Client Managers; saves are available only to Client Admins. Roles outside that scope receive non-enumerating access handling instead of tenant details.
Tenant identity comes from your signed-in session, not from a browser-supplied tenant ID. Navigation visibility is not a security boundary; access and saves are checked against your role and tenant scope.
Each save includes the version loaded with the current settings, so a change another user made after you opened the section is rejected by the server rather than silently overwritten. Save requests must first pass the portal's standard CSRF check, and a rate limit of five save attempts per user and tenant per minute is applied after that check.
The Tenant Settings panel sends the standard double-submit CSRF token with same-origin session credentials. Structured save failures are shown using the message and field details returned by the portal route.
#Field Reference
| Field Name | Description | Validation Rules | Default Behaviour |
|---|---|---|---|
| Display Timezone | The tenant-level timezone preference stored with tenant settings | Optional. An empty timezone means no tenant preference. Non-empty values must be valid IANA timezone identifiers and must be 50 characters or fewer. The selector offers no empty choice, so a timezone that is already set can be changed but not cleared from the portal. | Seeded from the tenant profile timezone when first created, otherwise blank. |
| Regional Format | The tenant-level locale preference stored with tenant settings | Required. Current allowed values are en-AU, en-US, and en-GB. | Seeded as en-AU when the tenant settings record is first created. |
| Billing Contact Name | The tenant billing contact name | Optional only as a pair with Billing Contact Email. Maximum 200 characters. Only letters, numbers, spaces, hyphens, apostrophes, periods, and commas are accepted. | Seeded from the tenant profile contact name only when both contact name and business email are available. |
| Billing Contact Email | The tenant billing contact email address | Optional only as a pair with Billing Contact Name. Maximum 254 characters and must be a valid email address when provided. | Seeded from the tenant profile business email only when both contact name and business email are available. |
| Security Contact Name | The tenant security contact name | Optional only as a pair with Security Contact Email. Maximum 200 characters. Only letters, numbers, spaces, hyphens, apostrophes, periods, and commas are accepted. | Blank until set. |
| Security Contact Email | The tenant security contact email address | Optional only as a pair with Security Contact Name. Maximum 254 characters and must be a valid email address when provided. | Blank until set. |
| Branding Display Name | Optional customer-safe tenant branding name | Optional. Maximum 100 characters. Only letters, numbers, spaces, hyphens, apostrophes, ampersands, periods, and commas are accepted. | Blank until set. |
| Last changed | When the current tenant settings were last changed | Display-only. | Shown when available. |
| Changed by | The user or system actor that last changed the tenant settings | Display-only. | Shows system until the first successful change, because the initial record is created by the system on first access. |
#Common Issues
| Issue | Resolution |
|---|---|
| Cannot access tenant settings | Client Admins can edit tenant settings and reach them via /settings?section=tenant-settings (there is no visible Client Admin Settings entry), Client Managers can review them, and Client Staff do not receive this Settings section. Direct links for roles without access resolve to another visible Settings section or receive non-enumerating access handling. |
| Cannot edit tenant settings | Your role may be summary-only, your tenant may not be active, or the section may have returned an unavailable state from the server. |
| Timezone is rejected | Choose a valid IANA timezone from the selector. The selector has no empty option, so a timezone that is already set cannot be cleared from the portal. |
| Locale is rejected | Choose one of the regional formats returned by the portal. The current supported values are en-AU, en-US, and en-GB. |
| Contact fields will not save | Billing and security contacts must each be provided as name-and-email pairs. The form rejects a partial pair with an inline message before the save is submitted. |
| Branding display name is rejected | Remove unsupported characters and keep the value to 100 characters or fewer. |
| Tenant settings do not save | Follow the specific error shown by the portal. Refresh before retrying if the session security check expired or another user changed the settings, and correct any highlighted fields before saving again. |
| Logo upload is missing | Logo upload is not implemented in the current Tenant Settings section. Contact your AiDial delivery partner for brand asset changes. |