API Docs / Schemas / SendEngagementEmailRequest

SendEngagementEmailRequest

Optional per-send options for emailing an engagement. The body may be omitted entirely, in which
case the tenant's Proposal Settings decide everything.

Properties

Name Type Description
addToPipelineboolean

Whether to add the client to a sales pipeline as part of this send. Null falls back to the
tenant's Proposal Settings; false skips the add for this send only. Has no effect when
"Add Client to Sales Pipeline" is switched off for the tenant — the send screen can opt out
of the practice default, not opt in to it.

Whether to add the client to a sales pipeline as part of this send. Null falls back to the
tenant's Proposal Settings; false skips the add for this send only. Has no effect when
"Add Client to Sales Pipeline" is switched off for the tenant — the send screen can opt out
of the practice default, not opt in to it.

pipelineCodestring

Sales pipeline to add the client to, overriding the one configured in Proposal Settings for
this send only. Null uses the configured pipeline. Ignored when AddToPipeline is false.

Sales pipeline to add the client to, overriding the one configured in Proposal Settings for
this send only. Null uses the configured pipeline. Ignored when AddToPipeline is false.

JSON Example

{
  "addToPipeline": false,
  "pipelineCode": "string"
}

Used By Operations