EngagementSettingsDto
Tenant-level configuration for engagement behavior, branding, and notification settings.
Controls how engagements are presented to clients, what happens when they're accepted,
and how engagement emails are formatted and delivered.
Properties
| Name | Type | Description |
|---|---|---|
| code | string | Unique identifier for the settings |
Unique identifier for the settings | ||
| introContentBlock | CodeAndNameDto | |
| thankYouContentBlock | CodeAndNameDto | |
| emailContentBlock | CodeAndNameDto | |
| acceptanceTask | CodeAndNameDto | |
| notifyClientManagerOnAcceptance | boolean | Whether to send an email notification to the client manager when an engagement is accepted |
Whether to send an email notification to the client manager when an engagement is accepted | ||
| notifyPartnerOnAcceptance | boolean | Whether to send an email notification to the partner when an engagement is accepted |
Whether to send an email notification to the partner when an engagement is accepted | ||
| designTheme | CodeAndNameDto | |
| showPracticeName | boolean | Whether to display the practice name on engagement acceptance pages and documents |
Whether to display the practice name on engagement acceptance pages and documents | ||
| attachPDFs | boolean | Whether to attach engagement PDFs to the engagement email |
Whether to attach engagement PDFs to the engagement email | ||
| thankYouEmailContentBlock | CodeAndNameDto | |
| requestDdMandate | boolean | Whether to request a Direct Debit mandate when engagement is accepted |
Whether to request a Direct Debit mandate when engagement is accepted | ||
| requestAmlOnboarding | boolean | Whether to request AML onboarding for the main contact when engagement is accepted |
Whether to request AML onboarding for the main contact when engagement is accepted | ||
| amlOnboardingLevelId | string | The AML platform onboarding level ID to use when creating the onboarding request |
The AML platform onboarding level ID to use when creating the onboarding request | ||
| signaturePageContentBlock | CodeAndNameDto | |
| useThirdPartyProposalPlatform | boolean | Whether to use a third-party platform (e.g., Socket) for proposals instead of native Sodium proposals |
Whether to use a third-party platform (e.g., Socket) for proposals instead of native Sodium proposals | ||
| addToPipelineOnSend | boolean | Whether to add the client to a sales pipeline when their proposal is first sent |
Whether to add the client to a sales pipeline when their proposal is first sent | ||
| onSendPipeline | CodeAndNameDto | |
JSON Example
{
"code": "string",
"introContentBlock": {
"code": "string",
"name": "string"
},
"thankYouContentBlock": {
"code": "string",
"name": "string"
},
"emailContentBlock": {
"code": "string",
"name": "string"
},
"acceptanceTask": {
"code": "string",
"name": "string"
}
}