Create Candidate
The endpoint will allow you to create a candidate
Resource Path
| url | candidates |
|---|
Input Data
| referenceFrom | String : The origin of the candidate (portal, linkedin, facebook, google, indeed, jobillico, …) |
|---|---|
| phoneNumber | String : The phone number of the candidate |
| name | String : The full name of the candidate (Firstname and Lastname) |
| String : The email of the candidate | |
| experience | Number : The number of year of experience of a candidate |
| requestedSalary | Number : The target salary of a candidate |
| preferedLanguage | String : The prefered language of the candidate |
| frenchLevel | Integer (from 0 to 5) : The level of knowledge of french of the candidate |
| englishLevel | Integer (from 0 to 5) : The level of knowledge of english of the candidate |
| String : The facebook page of the candidate | |
| String : The linkedin page of the candidate | |
| String : The twitter page of the candidate | |
| github | String : The github page of the candidate |
| indeed | String : The indeed page of the candidate |
| website | String : The website page of the candidate |
| monster | String : The monster page of the candidate |
| files | Array of File object : The list of file to attache to that candidate |
| educations | Array of Education object : The list schools of the candidate |
| employers | Array of Employer object : The list professional experiences of the candidate |
File object
| id | String : Unique ID of the file (that provide to you throw the File endpoint) |
|---|---|
| name | String : Name of the file |
| type | String : The type of the file (CV, CoverLetter, …) |
| text | String : The content of the file (this is also provided if you create this file using the File endpoint) |
Education object
| schoolName | String : The name of the school |
|---|---|
| degree | String : The name of the degree |
| field | String : The field of the degree |
| grade | String : The grade of the degree |
| description | String : A description of the degree |
| from | Date : The starting date of the program for that candidate |
| to | Date : The end date of the program for that candidate |
Employer object
| position | String : The job title |
|---|---|
| name | String : The job name |
| location | String : The job address |
| description | String : The job description |
| from | Date : The starting date of the job for that candidate |
| to | Date : The end date of the job for that candidate |
All date format use the follow pattern : yyyy-MM-dd’T’HH:mm:ss.SSS’Z’
Response
| id | String : Unique ID of the candidate |
|---|---|
| referenceFrom | String : The origin of the candidate (portal, linkedin, facebook, google, indeed, jobillico, …) |
| phoneNumber | String : The phone number of the candidate |
| name | String : The full name of the candidate (Firstname and Lastname) |
| String : The email of the candidate | |
| preferedLanguage | String : The prefered language of the candidate |
| files | Array : The list of file to attache to that candidate |
Error Code
| 409 | This candidate already exist (we return the existing candidate in the payload) |
|---|
curl -X POST \ 'https://public-api.nextal.com/candidates?napikey=demo&ntenant=demo' \ -H 'accept: application/json' \ -H 'cache-control: no-cache,no-cache' \ -H 'content-type: application/json;charset=UTF-8' \ -d '{ "files": [{ "name":"CV Mickael Dupont.pdf", "id":"5c8745402c17ca4144a566bb", "type":"CV", "text":" Content of the CV" }], "referenceFrom":"Portal", "phoneNumber":"5146525499", "address":null, "email":"dupont.mickael@gmail.com", "linkedin":"www.linkedin.com/in/mickael-", "name":"Mickal dupont", "preferedLanguage":"fr"}'