API Docs / Schemas / UpdateEngagementSettingsRequest

UpdateEngagementSettingsRequest

Request to update engagement settings for the tenant

Properties

Name Type Description
introContentBlockCodestring

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

thankYouContentBlockCodestring

Code of the content block to display after engagement acceptance

Code of the content block to display after engagement acceptance

emailContentBlockCodestring

Code of the content block to include in the engagement email body

Code of the content block to include in the engagement email body

acceptanceTaskCodestring

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

notifyClientManagerOnAcceptanceboolean

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

notifyPartnerOnAcceptanceboolean

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

designThemeCodestring

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

showPracticeNameboolean

Whether to display the practice name on engagement acceptance pages and documents

Whether to display the practice name on engagement acceptance pages and documents

attachPDFsboolean

Whether to attach engagement PDFs to the engagement email

Whether to attach engagement PDFs to the engagement email

thankYouEmailContentBlockCodestring

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

requestDdMandateboolean

Whether to request a Direct Debit mandate when engagement is accepted

Whether to request a Direct Debit mandate when engagement is accepted

requestAmlOnboardingboolean

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

amlOnboardingLevelIdstring

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

signaturePageContentBlockCodestring

Code of the content block to use as the signature page in engagement documents

Code of the content block to use as the signature page in engagement documents

useThirdPartyProposalPlatformboolean

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

addToPipelineOnSendboolean

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

onSendPipelineCodestring

Code of the sales pipeline clients are added to when their proposal is first sent

Code of the sales pipeline clients are added to when their proposal is first sent

JSON Example

{
  "introContentBlockCode": "string",
  "thankYouContentBlockCode": "string",
  "emailContentBlockCode": "string",
  "acceptanceTaskCode": "string",
  "notifyClientManagerOnAcceptance": false
}

Used By Operations