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 | ||
| emailSubject | string | Subject line template for engagement emails (can include merge fields) |
Subject line template for engagement emails (can include merge fields) | ||
| thankYouEmailContentBlock | CodeAndNameDto | |
| thankYouEmailSubject | string | Subject line template for thank you emails sent after engagement acceptance |
Subject line template for thank you emails sent after engagement acceptance | ||
| requestDdMandate | boolean | Whether to request a Direct Debit mandate when engagement is accepted |
Whether to request a Direct Debit mandate when engagement is accepted | ||
JSON Example
{
"code": "string",
"introContentBlock": {
"code": "string",
"name": "string"
},
"thankYouContentBlock": {
"code": "string",
"name": "string"
},
"emailContentBlock": {
"code": "string",
"name": "string"
},
"acceptanceTask": {
"code": "string",
"name": "string"
}
}