Skip to main content
POST
/
rest
/
v2
/
applicants
Creates or update a profile and job application
curl --request POST \
  --url https://functions.prod.jarvi.tech/v1/public-api/rest/v2/applicants \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "referenceId": "JARVI001",
  "projectId": "713a8005-e54d-4ee3-b6a4-89b27167dde6",
  "firstName": "Quentin",
  "lastName": "Decré",
  "emailAddresses": "[email protected], [email protected]",
  "phoneNumbers": "+33752626164,0240493773",
  "linkedinUrl": "https://www.linkedin.com/in/quentindecre/",
  "historyEntrySubject": "Application from website",
  "historyEntryMessage": "The message of the historyentry you want to show in the profile’s Jarvi history",
  "resumesFiles": [
    {
      "fileName": "cv.pdf",
      "data": "data:@file/pdf;base64,JVBERi0......AABTLAAAAAA="
    }
  ],
  "files": [
    {
      "fileName": "motivation.docx",
      "data": "data:@file/vnd.openxmlformats-officedocument.wordprocessingml.document;base64,UEsDBBQ......AABTLAAAAAA="
    }
  ],
  "externalId": "Your id. Will merge with exisiting profile with same externalId",
  "id": "Jarvi uuid. Will merge with exisiting profile with same id",
  "location": "Rennes, France",
  "headline": "Co-Founder Jarvi",
  "currentCompanyName": "Jarvi",
  "currentCompanyId": "Jarvi",
  "currentPosition": "Co-founder",
  "<any custom field uuid>": "My custom field value for this profile"
}
'
{
  "message": "Profile saved successfully",
  "taskId": "0b538428-7652-4243-baaf-3867803d7007",
  "profileId": "d730cca9-d8b0-49e7-b2e0-c58c1bb7af9f"
}
Sie können Ihren öffentlichen API-Schlüssel für diese Anfrage verwenden. Das ermöglicht es Ihnen, dies direkt im Javascript-Code der Website zu tun.
Die maximale Größe der Anfrage beträgt 4,5 MB. Wir empfehlen Ihnen, die Größe Ihres Lebenslauf-Upload-Feldes auf eine kleinere Größe zu begrenzen.
Sie können alles im Profil über Benutzerdefinierte Felder speichern. Klicken Sie auf diesen Link, um zu verstehen, wie Sie Informationen in benutzerdefinierten Feldern lesen und schreiben können.

Authorizations

​
X-API-KEY
string
header
required

Body

application/json
​
referenceId
string

The reference id of the job application. If provided, Jarvi will associate the profile to the right recruitment project

Example:

"JARVI001"

​
projectId
string

(rarely used) As for the reference id, but with the Jarvi internal project id. You can use projectId, referenceId or none of them if you want to create a profile without linking it to a project

Example:

"713a8005-e54d-4ee3-b6a4-89b27167dde6"

​
firstName
string

If not provided, will be extracted from the resume or Linkedin URL. If no resume or Linkedin URL, will be required

Example:

"Quentin"

​
lastName
string

If not provided, will be extracted from the resume or Linkedin URL. If no resume or Linkedin URL, will be required

Example:

"Decré"

​
emailAddresses
string

Multiple email addresses separated by a comma. If not provided, will be extracted from the resume or Linkedin URL.

Example:

"[email protected], [email protected]"

​
phoneNumbers
string

Multiple phone numbers separated by a comma. If not provided, will be extracted from the resume or Linkedin URL.

Example:

"+33752626164,0240493773"

​
linkedinUrl
string

The linkedin URL of the profile. If provided, Jarvi will extract the profile informations from the linkedin profile

Example:

"https://www.linkedin.com/in/quentindecre/"

​
historyEntrySubject
string

The subject of the historyentry you want to show in the profile’s Jarvi history. If not provided, will be "Candidature depuis formulaire web"

Example:

"Application from website"

​
historyEntryMessage
string

The message of the historyentry you want to show in the profile’s Jarvi history

Example:

"The message of the historyentry you want to show in the profile’s Jarvi history"

​
resumesFiles
object[]

The resume(s) of the profile. Will be parsed by Jarvi. Remember to convert to base64 before sending

​
files
object[]

(rarely used) Any file you want to upload with the profile. Will not be parsed. Remember to convert to base64 before sending

​
externalId
string

(rarely used) Your id. Will merge with exisiting profile with same externalId

Example:

"Your id. Will merge with exisiting profile with same externalId"

​
id
string

(rarely used) Jarvi uuid. Will merge with exisiting profile with same id

Example:

"Jarvi uuid. Will merge with exisiting profile with same id"

​
location
string

The location of the profile. If not provided, will be extracted from the resume or Linkedin URL

Example:

"Rennes, France"

​
headline
string

The headline of the profile. If not provided, will be extracted from the resume or Linkedin URL

Example:

"Co-Founder Jarvi"

​
currentCompanyName
string

The current company name of the profile. If not provided, will be extracted from the resume or Linkedin URL. If a company with this name exists, the profile will be associated as contact of this company

Example:

"Jarvi"

​
currentCompanyId
string

If a company with this id exists, the profile will be associated as contact of this company

Example:

"Jarvi"

​
currentPosition
string

The current job title of the profile. If not provided, will be extracted from the resume or Linkedin URL

Example:

"Co-founder"

​
<any custom field uuid>
string

Any custom field you want to add to the profile. You can find the uuid of the custom field in the Jarvi settings. If you want to provide multiple values, you can separate them with a comma

Example:

"My custom field value for this profile"

Response

The application has been saved

​
message
string
Example:

"Profile saved successfully"

​
taskId
string
Example:

"0b538428-7652-4243-baaf-3867803d7007"

​
profileId
string
Example:

"d730cca9-d8b0-49e7-b2e0-c58c1bb7af9f"