#Consent Notice (Compliance Copy)

6 min read
RoleAccess Level
Client AdminEdit
Client ManagerView summary only
Client StaffNo section

#Overview

Consent Notice settings are managed from the Compliance Copy section in Settings at /settings?section=compliance-copy. The panel lets Client Admins manage customer-safe caller privacy and consent copy for one in-scope project at a time.

This customer settings panel does not provide a separate consent-notice version list, HTML editor, externally hosted notice URL, or Set as Active action. Instead, it shows the selected project's saved working copy, the currently published runtime copy, approved consent-template options when editing is available, preview text, provenance, and runtime publish status.

#Prerequisites

  • You are signed in to the AiDial portal as a Client Admin to edit, or as a Client Manager to review a summary. See Signing In for instructions.
  • Your session includes at least one in-scope project.
  • Open /settings?section=compliance-copy, or use the Compliance Copy settings entry if it is visible for your role.

#Access and Scope

The browser uses your portal session; you do not need to enter or send an API key. The browser calls the portal server, and the portal server forwards your bearer-authenticated request to aidial_api. Project access is resolved server-side from your authenticated session, and the browser sees only browser-safe project references.

Client Staff do not receive this Settings section. Client Managers see customer-safe rendered summaries only. Client Admins can edit when the selected project is editable from the portal; some projects remain summary-only when the published runtime requires the partner-managed workflow. Navigation visibility is not the security boundary: the settings API route still enforces role and project scope for direct links.

  1. Open /settings?section=compliance-copy, or navigate to Settings > Compliance Copy if the entry is visible.
  2. If more than one project is available, choose the project you want to review. Client Admins use the shared Settings project scope control; summary-only roles use the project selector inside the panel when it is shown.
  3. Review the project name, timezone, provenance, last changed time, runtime publish status, and published runtime observation time.
  4. Choose an approved Consent template revision, if the panel is editable and the consent wording needs to change.
  5. Optionally enter Optional custom consent text. This plain-text copy is appended after the selected approved template in the preview.
  6. Review the collection notice and consent notice preview.
  7. Select Save compliance copy.

Screenshot reference: Compliance Copy panel with project selector and runtime status

Screenshot reference: Compliance Copy consent template and preview fields

Saving stores the project-scoped working copy. The Runtime publish status indicates whether the saved working copy already matches the published runtime, is pending publish, or is not publish-ready. Do not treat a saved change as active for callers until the published runtime status confirms it.

#Field Reference

Field NameDescriptionValidation RulesDefault Behaviour
ProjectThe in-scope project whose compliance copy is being reviewed or editedRequired when more than one project is available. Project choices come from your session scope and are resolved server-side.The single in-scope project is selected automatically; multi-project sessions must choose one before copy details load.
Collection notice titleCaller-facing collection notice title saved with the compliance-copy working copyRequired. Plain text only. Single line. 1 to 120 characters.Loaded from the selected project's current projection.
Collection notice bodyCaller-facing collection notice body saved with the compliance-copy working copyRequired. Plain text only. Line breaks are supported. 1 to 1,000 characters.Loaded from the selected project's current projection.
Consent templateApproved consent-template revision used for caller-facing consent wordingRequired to save an editable draft. Choose one approved global or client template revision from the list.Loaded from the selected project's current projection when available.
Optional custom consent textExtra plain-text consent wording appended after the approved templateOptional. Plain text only. Up to 300 characters when present.Blank means no custom consent text is appended.
Runtime publish statusWhether the saved working copy matches the published runtimeRead only. Values include published runtime matches, pending publish, and not publish-ready.Calculated by AiDial from saved working and published runtime state.

#Runtime State and History

The customer-facing panel does not expose a separate Create Version, Publish, Restore as Draft, or Set as Active action. Backend revision tracking records saved working-copy changes, while the portal displays the current primary projection, published runtime projection, and saved working projection when available.

The panel may show:

  • Published runtime matches — the saved working copy matches the published runtime.
  • Pending publish — the saved working copy differs from the runtime copy and still needs the partner-managed publish workflow.
  • Not publish-ready — the runtime state, approved template registry, or pinned template revision needs attention before it can be published safely.

#Empty and Summary States

  • No in-scope projects available — your current session does not include an active project that can show compliance copy.
  • Choose a project to continue — more than one project is in scope; select one before reviewing copy details. Client Admins may see this when the shared Settings project scope is still set to all projects.
  • Summary only — your role or the selected project's runtime state allows review, but not editing.
  • Managed elsewhere — the current published runtime cannot be edited safely from the portal panel; contact your delivery partner for changes.

#Common Issues

IssueResolution
Cannot access consent notice settingsClient Admins can edit through /settings?section=compliance-copy, Client Managers can review summaries, and Client Staff do not receive this Settings section. Access is enforced by the settings API route as well as navigation.
The save button is disabledThere may be no changes, a save may already be in progress, or the server may have rejected a stale draft and asked you to reload the latest state.
My consent text is rejectedUse plain text only. Optional custom consent text supports up to 300 characters.
My selected template is no longer availableChoose a currently approved template revision before saving again.
The panel says the change is pending publishThe working copy was saved, but the published runtime has not caught up yet. Use the runtime publish status before treating the change as active for callers.
The panel says the copy is managed elsewhereThe runtime state requires the partner-managed workflow. Contact your delivery partner.