Invite a candidate in a session
POST https://cvideo.arca24.careers/ws/v.1/session/{{session_id}}/candidate
This method allows you to invite a candidate to record a CVideo, associating him/her to an open session.
Input
- the session unique ID in the url of the endpoint.
- email*: candidate email
- mobile_phone: candidate mobile phone
- note: comment related to the candidate
- notsendemail: default false; if true, the system will not send the invitation mail to the inserted candidate
Output
- id: invitation unique ID
- first_name: candidate name
- family_name: candidate surname
- email: candidate e-mail address
- evaluation:evaluation given to the candidate
- comment:comment given to the candidate
- date_started: recording date
- declined: 1 if the invitation was declined, 0 if it was not
- done: 1 if it was completed, 0 if it was not
- session_id: session unique ID
- session_description: session description
- invitation_link: the candidate can join the session by this link
Request Body
{"email"=>"{{email}}", "mobile_phone"=>"{{mobile_phone}}", "note"=>"{{note}}", "not_send_email"=>false}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string | ||
Accept | string | ||
Authorization | string |