Leadline DocsToolsCandidates
createMeeting
Generated from the Rover tool catalog. Do not edit by hand.
Write. This tool changes Leadline data and runs immediately, with no approval card.
Schedule one meeting with exactly one candidate. Keep SmartLines literal (Hi {{Candidate Name}}, {{Meeting Host Link}}); never paste the candidate first name. Pass a snapshot copied from get/list/search. Default is virtual with a booking link. Omit meetingLink so SaaS generates one. Requires approval when enabled.
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| candidate | object | yes | Exactly one candidate snapshot |
| emailSubject | string | yes | Invite subject. Keep SmartLines literal, e.g. {{Candidate Name}} interview with {{Recruiter Name}}. Do not insert a real first name. |
| message | string | yes | HTML invite body. Keep SmartLines literal ({{Candidate Name}}, {{Meeting Host Link}}). Do not insert a real first name. |
| includeSignature | boolean | yes | Preview only; SaaS still attaches the host signature on the booking-link email |
| name | string | no | Meeting name shown on the calendar invite |
| meetingHostId | unknown | no | Colleague host id. Omit when the host is the current user. |
| host | object | no | Display-only host chip when the host is not the current user |
| positionId | unknown | no | Leadline entity id (unsigned bigint as digit string) |
| positionTitle | string | no | Display-only Associate-with-Position row |
| isVirtual | boolean | yes | |
| meetingLink | string | no | User-supplied URL; omit so SaaS generates one |
| location | object | no | In-person location object |
| attendees | array | no | Extra attendee emails |
| pickedDate | string | no | ISO datetime when the user names a time; omit so the candidate books |
| duration | integer | no | Meeting length in seconds |
| timezone | string | no |