Leadline DocsToolsCandidates
sendEmail
Generated from the Rover tool catalog. Do not edit by hand.
Write. This tool changes Leadline data and runs immediately, with no approval card.
Send one shared email to 1–50 candidates. Put every recipient in candidates[]; same subject and message for all. Personalize with literal {{Candidate Name}} — never paste a real name or split the same copy into one call per candidate. Copy snapshots from get/list/search in this run. Requires approval when enabled.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| candidates | array | yes | Every recipient of this one shared email (1–50 snapshots). One tool call when subject and message are the same; do not call once per candidate. |
| subject | string | yes | Shared subject. Keep SmartLines literal, e.g. Hello {{Candidate Name}}. Do not insert a real first name. |
| message | string | yes | Shared HTML body. Keep SmartLines literal. SaaS fills {{Candidate Name}} per recipient. |
| includeSignature | boolean | yes | When true, SaaS appends the user signature (excludeSignature=false) |
| templateId | unknown | no | Recorded when a listed template was chosen |
| positionId | unknown | no | Required when the copy uses position SmartLines |
| channelId | unknown | no | Leadline entity id (unsigned bigint as digit string) |