UpdateEngagementSettingsRequest
Request to update engagement settings for the tenant
Properties
| Name | Type | Description |
|---|---|---|
| introContentBlockCode | string | Code of the content block to display at the start of engagement acceptance pages |
Code of the content block to display at the start of engagement acceptance pages | ||
| thankYouContentBlockCode | string | Code of the content block to display after engagement acceptance |
Code of the content block to display after engagement acceptance | ||
| emailContentBlockCode | string | Code of the content block to include in the engagement email body |
Code of the content block to include in the engagement email body | ||
| acceptanceTaskCode | string | Code of the recurring task template to automatically create when an engagement is accepted |
Code of the recurring task template to automatically create when an engagement is accepted | ||
| 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 | ||
| designThemeCode | string | Code of the design theme to apply to engagement documents and acceptance pages |
Code of the design theme to apply to engagement documents and acceptance pages | ||
| 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 |
Subject line template for engagement emails | ||
| thankYouEmailContentBlockCode | string | Code of the content block to use for thank you email sent to client after engagement acceptance |
Code of the content block to use for thank you email sent to client after engagement acceptance | ||
| 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
{
"introContentBlockCode": "string",
"thankYouContentBlockCode": "string",
"emailContentBlockCode": "string",
"acceptanceTaskCode": "string",
"notifyClientManagerOnAcceptance": false
}