Type alias PublicPortalConfig

PublicPortalConfig: {
    chat?: PublicPortalChatConfig;
    contactEmail?: string;
    displayName?: string;
    heroSubtitle?: string;
    heroTitle?: string;
    hostname?: string;
    hostnames?: string[];
    logoUrl?: string;
    lookupButtonLabel?: string;
    notFoundMessage?: string;
    recipientField?: string;
    shortCodeLabel?: string;
    showAttachments?: boolean;
    showCaseId?: boolean;
    showSummary?: boolean;
    supportHint?: string;
    supportMessage?: string;
    supportPhone?: string;
    theme?: PublicPortalTheme;
    titleFormat?: string;
}

Type declaration

  • Optional chat?: PublicPortalChatConfig

    support chat integration

  • Optional contactEmail?: string

    support email shown in the portal shell

  • Optional displayName?: string

    brand name shown in the portal shell

  • Optional heroSubtitle?: string

    subheading shown above the lookup form

  • Optional heroTitle?: string

    heading shown above the lookup form

  • Optional hostname?: string

    single explicit portal hostname

  • Optional hostnames?: string[]

    list of hostnames that should resolve to this tenant portal

  • Optional logoUrl?: string

    logo shown in the portal shell

  • Optional lookupButtonLabel?: string

    label used for the submit button

  • Optional notFoundMessage?: string

    message shown when no case matches the code

  • Optional recipientField?: string

    attachment field used as public recipient label

  • Optional shortCodeLabel?: string

    label used for the tracking code input

  • Optional showAttachments?: boolean

    whether the API should include attachment metadata on the case details screen

  • Optional showCaseId?: boolean

    whether the API should expose the internal case UUID

  • Optional showSummary?: boolean

    whether the API should include the process summary on the case details screen

  • Optional supportHint?: string

    legacy alias for supportMessage

  • Optional supportMessage?: string

    helper text shown across the portal and result screen

  • Optional supportPhone?: string

    support phone shown in the portal shell

  • Optional theme?: PublicPortalTheme

    portal theme overrides

  • Optional titleFormat?: string

    public-facing title format for the lookup result header

Settings

Member Visibility

Theme