#Settings Overview

7 min read
RoleAccess Level
Client AdminCan edit available customer-managed settings, request account exports, and submit or cancel data deletion requests. Your own profile and active sessions live in the Account area (/account), not the Settings shell.
Client ManagerCan review notification and other tenant or project setting summaries; Data Deletion is not shown for this role. Your own profile and active sessions live in the Account area (/account), not the Settings shell.
Client StaffSees only the Reports section, as a read-only schedule summary and delivery history. Notifications and all other operational or tenant settings are not shown. Your own profile and active sessions live in the Account area (/account), not the Settings shell.

#Overview

The Settings area at /settings collects the customer-managed settings for your organisation. The sidebar entry is labelled Settings for all three client roles. Client Admin sees the page titled Project Settings with a flat menu ordered for everyday use; Client Manager and Client Staff see it titled Settings with the menu grouped into Operations, Compliance and privacy, Account and security, and Data and reports. On narrow screens every role gets the same grouped section selector.

The shell covers optional notification preferences, report schedules and delivery history, and the customer settings your role can reach — opening hours, call handling, compliance copy, transfer settings, tenant settings, IP allowlisting, secondary use, account exports, and data deletion requests. Your own profile and active sessions are managed separately in the Account area (/account): opening /settings?section=profile redirects a Client Admin to /account?section=profile, and for Client Manager and Client Staff both ?section=profile and ?section=active-sessions return a not-found state under /settings. Data Governance is a partner-managed retention surface and is not shown in the client Settings shell for any client role.

Each section has a server-resolved role and scope state. Some roles can edit, some can only review a summary, and sections that do not provide useful role-specific value are omitted from the shell. Plan and entitlement information is available on the separate /settings/entitlements route.

#Prerequisites

  • You are signed in to the AiDial portal. See Signing In for instructions.
  • Your current session has an active tenant and the required role for the setting you want to open.
  • Project-specific sections require at least one in-scope project. If your session has more than one project, confirm which project is selected before reviewing or saving that setting.
  1. Select Settings from the sidebar.
  2. Select a section in the navigation. The portal keeps the selected section in the URL using ?section=.... Client Admin and Client Manager open on Opening hours; Client Staff opens on Reports, the only section available to that role. The visible Client Admin menu shows Opening hours, Notifications, and Reports; the other editable sections (Call handling, Transfers, Tenant Settings, Security, Consent Notice, Secondary Use, Active Sessions, Data Exports, and Data Deletion) are deep-link only — open them with their ?section=... link.
  3. Check the label on the section:
  • An Admin managed label means your role can review a summary but cannot save changes.
  • Sections your role can edit carry no label.
  • Sections that do not provide useful access for your role are hidden instead of opening a dead-end panel.
  1. For project-scoped sections, confirm the project. Client Admin uses the project switcher in the sidebar, and the portal writes the choice into the URL as project_id — carrying over your last used project, or the first project in scope. Client Manager picks the project inside the section panel itself.
  2. Open Plan and Entitlements from /settings/entitlements when you need plan and feature-limit information.

Navigation visibility is a convenience. If your role or organisation scope does not allow a setting, the portal blocks the request even if you open a direct link.

#Available Sections

SectionLocationClient AdminClient ManagerClient Staff
Profile/account?section=profileManaged in Account (/settings?section=profile redirects here)Managed in Account (/settings?section=profile is not-found)Managed in Account (/settings?section=profile is not-found)
Notifications/settings?section=notificationsEditSummary onlyNo section
Reports/settings?section=reports (the legacy /settings/reports link redirects here)Edit schedules, send synthetic samples, and view delivery historyRead-only schedule summary and delivery historyRead-only schedule summary and delivery history
Opening hours/settings?section=business-hoursEditSummary onlyNo section
Call handling/settings?section=call-limitsEdit (deep link only)Summary onlyNo section
Security (IP allowlist)/settings?section=securityEdit (deep link only)Summary onlyNo section
Consent Notice (Compliance Copy)/settings?section=compliance-copyEdit (deep link only)Summary onlyNo section
Secondary Use/settings?section=secondary-useEdit (deep link only)Summary onlyNo section
Transfer Settings/settings?section=transfer-settingsEdit (deep link only)Summary onlyNo section
Tenant Settings/settings?section=tenant-settingsEdit (deep link only)Summary onlyNo section
Data Governance/settings?section=data-governanceNo sectionNo sectionNo section
Active Sessions/account?section=securityManage own sessions in Account; also the /settings?section=active-sessions deep linkManage own sessions in Account (/settings?section=active-sessions is not-found)Manage own sessions in Account (/settings?section=active-sessions is not-found)
Data Exports/settings?section=data-exportsRequest, cancel, download, and view (deep link only)No sectionNo section
Data Deletion/settings?section=data-deletionSubmit, cancel, and view (deep link only)No sectionNo section
Plan and Entitlements/settings/entitlementsDetail viewSummary onlyNo access

"No section" means the server does not include that section in the settings shell for the role. Most direct links to non-emitted sections normalise to the first allowed Settings section; the relocated Profile and Active Sessions links for Client Manager and Client Staff instead return a not-found state. "(deep link only)" means the section is intentionally kept out of the visible Client Admin Settings sidebar, but it is still served for that role, so its direct link resolves straight to the panel under the existing role and project rules. When you open one of these deep-link-only sections, the Settings rail keeps showing the three visible tabs (Opening hours, Notifications, Reports) and adds a small "Viewing: <Section>" caption above them so you can see which hidden section is open. Legacy links using ?section=session-management normalise to the canonical ?section=active-sessions slug; for Client Admin this opens the Active Sessions deep-link panel, while for Client Manager and Client Staff it returns the same not-found state as ?section=active-sessions (own sessions live in the Account area).

#Access, Scope, and Runtime Behaviour

The browser uses your signed-in portal session. You do not need to enter or send an API key.

Tenant settings, data exports, data deletion, secondary use, IP allowlisting, and entitlements are tenant-scoped: they apply to your whole organisation and take no project selection. Reports is also tenant-wide — schedules and delivery history cover the whole organisation — but the portal still keeps one project selected in the address while that section is open. Notifications, opening hours, call handling, compliance copy, and transfer settings are project-scoped and only offer projects from the current session scope. Out-of-scope project requests are rejected server-side without exposing other project identifiers.

Send sample uses the recipients already saved on that report schedule; it does not accept a separate browser recipient list. If delivery status is uncertain, the portal shows a generic temporary-unavailable message and reuses the same logical request on Retry so confirmed recipients are not sent twice. Add a recipient before retrying a no_recipients response, and wait for the displayed retry period after a rate-limit response.

#Common Issues

IssueResolution
A settings section is missingYour role may not have access to that section, or the server may have omitted it because it would not provide useful read-only value. Check the table above or contact your Client Administrator.
A project-scoped section asks you to choose a projectYour session has more than one in-scope project. Select the project you want to review before continuing.
A project cannot be selectedThe project is not in your current session scope or is no longer active for that setting. Refresh the page and choose from the displayed list.
Changes are not savingEnsure all required fields are completed, review validation messages, and reload if the setting changed elsewhere before you saved.
Plan and Entitlements is not in the settings tab listIt opens as a separate settings page at /settings/entitlements, not as a tab in the main settings shell.