Sends an email for the engagement using the tenant's email settings.
The email will be sent to the recipient specified in the engagement.
The email will be queued for sending and a message ID will be returned.
A record will be created linking the engagement to the sent email.
The body is optional. It carries per-send choices made on the send screen — currently which
sales pipeline (if any) to add the client to, overriding Proposal Settings for this send only.
Requires: Update on Engagements.
Parameters
| Name | Type | Description |
|---|---|---|
| tenant* | path string | The Tenant.Code |
The Tenant.Code |
||
| code* | path string | |
Request Body
{
"addToPipeline": false,
"pipelineCode": "string"
}Responses
200 OK
400 Bad Request
401 Unauthorized – Invalid or missing API key
403 Forbidden – the caller lacks the permissions this endpoint requires; the detail lists every one missing
application/problem+json
404 Not Found