UpdateClientPortalSettingsRequest
Request to update client portal settings for the tenant
Properties
| Name | Type | Description |
|---|---|---|
| portalTitle | string | The title displayed on the client portal |
The title displayed on the client portal | ||
| designThemeCode | string | Code of the design theme to apply to the client portal |
Code of the design theme to apply to the client portal | ||
| iconImageAssetCode | string | Code of the image asset to use as the portal icon/favicon |
Code of the image asset to use as the portal icon/favicon | ||
| showInvoices | boolean | Whether portal users can view their invoices |
Whether portal users can view their invoices | ||
| showServices | boolean | Whether portal users can view the services set up for them in Sodium |
Whether portal users can view the services set up for them in Sodium | ||
| invitationEmailContentBlockCode | string | Code of the content block to use for portal invitation emails |
Code of the content block to use for portal invitation emails | ||
| useIntroPageContentBlock | boolean | 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. | ||
| introPageContentBlockCode | string | Code of the content block to use for the intro page |
Code of the content block to use for the intro page | ||
| introPageText | string | Raw HTML content for the intro page (used when UseIntroPageContentBlock is false) |
Raw HTML content for the intro page (used when UseIntroPageContentBlock is false) | ||
| documentApprovalEmailContentBlockCode | string | Code of the content block to use as the email body template for document approval request emails |
Code of the content block to use as the email body template for document approval request emails | ||
| documentRequestOpenedEmailContentBlockCode | string | Code of the content block to use as the email body template when a document request is opened |
Code of the content block to use as the email body template when a document request is opened | ||
| documentRequestRejectedEmailContentBlockCode | string | Code of the content block to use as the email body template when a document request submission is rejected |
Code of the content block to use as the email body template when a document request submission is rejected | ||
| documentRequestSubmittedEmailContentBlockCode | string | Code of the content block to use as the email body template when a document request submission is received |
Code of the content block to use as the email body template when a document request submission is received | ||
| clientConfirmationEmailContentBlockCode | string | Code of the content block to use as the email body template for client confirmation workflow step emails |
Code of the content block to use as the email body template for client confirmation workflow step emails | ||
| notifyManagerOnClientDocumentUpload | boolean | 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 | ||
| chaseDocumentRequestFrequencyDays | integer | How often (in days) to chase open document requests |
How often (in days) to chase open document requests | ||
| chaseDocumentApprovalFrequencyDays | integer | How often (in days) to chase pending document approvals |
How often (in days) to chase pending document approvals | ||
| chaseClientConfirmationFrequencyDays | integer | How often (in days) to chase pending client confirmations |
How often (in days) to chase pending client confirmations | ||
| clientChaseEmailContentBlockCode | string | Code of the content block to use as the email body template for client chase emails |
Code of the content block to use as the email body template for client chase emails | ||
JSON Example
{
"portalTitle": "string",
"designThemeCode": "string",
"iconImageAssetCode": "string",
"showInvoices": false,
"showServices": false
}