API Docs / Schemas / ClientPortalSettingsDto

ClientPortalSettingsDto

Client portal settings for the tenant

Properties

Name Type Description
portalTitlestring

The title displayed on the client portal

The title displayed on the client portal

designThemeCodeAndNameDto
iconImageAssetCodeAndNameDto
showInvoicesboolean

Whether portal users can view their invoices. Requires the tenant to be connected to an accounting provider and the client to be mapped to an accounting client.

Whether portal users can view their invoices. Requires the tenant to be connected to an accounting provider and the client to be mapped to an accounting client.

showServicesboolean

Whether portal users can view the services set up for them in Sodium, including prices and dates.

Whether portal users can view the services set up for them in Sodium, including prices and dates.

invitationEmailContentBlockCodeAndNameDto
useIntroPageContentBlockboolean

When true, the intro page uses the content block. When false, it uses IntroPageText.

When true, the intro page uses the content block. When false, it uses IntroPageText.

introPageContentBlockCodeAndNameDto
introPageTextstring

Raw HTML content for the intro page (when UseIntroPageContentBlock is false)

Raw HTML content for the intro page (when UseIntroPageContentBlock is false)

documentApprovalEmailContentBlockCodeAndNameDto
documentRequestOpenedEmailContentBlockCodeAndNameDto
documentRequestRejectedEmailContentBlockCodeAndNameDto
documentRequestSubmittedEmailContentBlockCodeAndNameDto
clientConfirmationEmailContentBlockCodeAndNameDto
notifyManagerOnClientDocumentUploadboolean

Whether to send an email notification to the client's manager when a document is uploaded via the portal

Whether to send an email notification to the client's manager when a document is uploaded via the portal

urlstring

The URL for the client portal (e.g. https://tenantcode.sodiumportal.com)

The URL for the client portal (e.g. https://tenantcode.sodiumportal.com)

JSON Example

{
  "portalTitle": "string",
  "designTheme": {
    "code": "string",
    "name": "string"
  },
  "iconImageAsset": {
    "code": "string",
    "name": "string"
  },
  "showInvoices": false,
  "showServices": false
}

Used By Operations