[Application] Create or update

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": "quentin@jarvi.tech, quentin@decre.tech",
  "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": "713a8005-e54d-4ee3-b6a4-89b27167dde6",
  "currentPosition": "Co-founder",
  "<any custom field uuid>": "My custom field value for this profile"
}
'

import requests

url = "https://functions.prod.jarvi.tech/v1/public-api/rest/v2/applicants"

payload = {
    "referenceId": "JARVI001",
    "projectId": "713a8005-e54d-4ee3-b6a4-89b27167dde6",
    "firstName": "Quentin",
    "lastName": "Decré",
    "emailAddresses": "quentin@jarvi.tech, quentin@decre.tech",
    "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": "713a8005-e54d-4ee3-b6a4-89b27167dde6",
    "currentPosition": "Co-founder",
    "<any custom field uuid>": "My custom field value for this profile"
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    referenceId: 'JARVI001',
    projectId: '713a8005-e54d-4ee3-b6a4-89b27167dde6',
    firstName: 'Quentin',
    lastName: 'Decré',
    emailAddresses: 'quentin@jarvi.tech, quentin@decre.tech',
    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: '713a8005-e54d-4ee3-b6a4-89b27167dde6',
    currentPosition: 'Co-founder',
    '<any custom field uuid>': 'My custom field value for this profile'
  })
};

fetch('https://functions.prod.jarvi.tech/v1/public-api/rest/v2/applicants', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://functions.prod.jarvi.tech/v1/public-api/rest/v2/applicants",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'referenceId' => 'JARVI001',
    'projectId' => '713a8005-e54d-4ee3-b6a4-89b27167dde6',
    'firstName' => 'Quentin',
    'lastName' => 'Decré',
    'emailAddresses' => 'quentin@jarvi.tech, quentin@decre.tech',
    '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' => '713a8005-e54d-4ee3-b6a4-89b27167dde6',
    'currentPosition' => 'Co-founder',
    '<any custom field uuid>' => 'My custom field value for this profile'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://functions.prod.jarvi.tech/v1/public-api/rest/v2/applicants"

	payload := strings.NewReader("{\n  \"referenceId\": \"JARVI001\",\n  \"projectId\": \"713a8005-e54d-4ee3-b6a4-89b27167dde6\",\n  \"firstName\": \"Quentin\",\n  \"lastName\": \"Decré\",\n  \"emailAddresses\": \"quentin@jarvi.tech, quentin@decre.tech\",\n  \"phoneNumbers\": \"+33752626164,0240493773\",\n  \"linkedinUrl\": \"https://www.linkedin.com/in/quentindecre/\",\n  \"historyEntrySubject\": \"Application from website\",\n  \"historyEntryMessage\": \"The message of the historyentry you want to show in the profile’s Jarvi history\",\n  \"resumesFiles\": [\n    {\n      \"fileName\": \"cv.pdf\",\n      \"data\": \"data:@file/pdf;base64,JVBERi0......AABTLAAAAAA=\"\n    }\n  ],\n  \"files\": [\n    {\n      \"fileName\": \"motivation.docx\",\n      \"data\": \"data:@file/vnd.openxmlformats-officedocument.wordprocessingml.document;base64,UEsDBBQ......AABTLAAAAAA=\"\n    }\n  ],\n  \"externalId\": \"Your id. Will merge with exisiting profile with same externalId\",\n  \"id\": \"Jarvi uuid. Will merge with exisiting profile with same id\",\n  \"location\": \"Rennes, France\",\n  \"headline\": \"Co-Founder Jarvi\",\n  \"currentCompanyName\": \"Jarvi\",\n  \"currentCompanyId\": \"713a8005-e54d-4ee3-b6a4-89b27167dde6\",\n  \"currentPosition\": \"Co-founder\",\n  \"<any custom field uuid>\": \"My custom field value for this profile\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://functions.prod.jarvi.tech/v1/public-api/rest/v2/applicants")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"referenceId\": \"JARVI001\",\n  \"projectId\": \"713a8005-e54d-4ee3-b6a4-89b27167dde6\",\n  \"firstName\": \"Quentin\",\n  \"lastName\": \"Decré\",\n  \"emailAddresses\": \"quentin@jarvi.tech, quentin@decre.tech\",\n  \"phoneNumbers\": \"+33752626164,0240493773\",\n  \"linkedinUrl\": \"https://www.linkedin.com/in/quentindecre/\",\n  \"historyEntrySubject\": \"Application from website\",\n  \"historyEntryMessage\": \"The message of the historyentry you want to show in the profile’s Jarvi history\",\n  \"resumesFiles\": [\n    {\n      \"fileName\": \"cv.pdf\",\n      \"data\": \"data:@file/pdf;base64,JVBERi0......AABTLAAAAAA=\"\n    }\n  ],\n  \"files\": [\n    {\n      \"fileName\": \"motivation.docx\",\n      \"data\": \"data:@file/vnd.openxmlformats-officedocument.wordprocessingml.document;base64,UEsDBBQ......AABTLAAAAAA=\"\n    }\n  ],\n  \"externalId\": \"Your id. Will merge with exisiting profile with same externalId\",\n  \"id\": \"Jarvi uuid. Will merge with exisiting profile with same id\",\n  \"location\": \"Rennes, France\",\n  \"headline\": \"Co-Founder Jarvi\",\n  \"currentCompanyName\": \"Jarvi\",\n  \"currentCompanyId\": \"713a8005-e54d-4ee3-b6a4-89b27167dde6\",\n  \"currentPosition\": \"Co-founder\",\n  \"<any custom field uuid>\": \"My custom field value for this profile\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://functions.prod.jarvi.tech/v1/public-api/rest/v2/applicants")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"referenceId\": \"JARVI001\",\n  \"projectId\": \"713a8005-e54d-4ee3-b6a4-89b27167dde6\",\n  \"firstName\": \"Quentin\",\n  \"lastName\": \"Decré\",\n  \"emailAddresses\": \"quentin@jarvi.tech, quentin@decre.tech\",\n  \"phoneNumbers\": \"+33752626164,0240493773\",\n  \"linkedinUrl\": \"https://www.linkedin.com/in/quentindecre/\",\n  \"historyEntrySubject\": \"Application from website\",\n  \"historyEntryMessage\": \"The message of the historyentry you want to show in the profile’s Jarvi history\",\n  \"resumesFiles\": [\n    {\n      \"fileName\": \"cv.pdf\",\n      \"data\": \"data:@file/pdf;base64,JVBERi0......AABTLAAAAAA=\"\n    }\n  ],\n  \"files\": [\n    {\n      \"fileName\": \"motivation.docx\",\n      \"data\": \"data:@file/vnd.openxmlformats-officedocument.wordprocessingml.document;base64,UEsDBBQ......AABTLAAAAAA=\"\n    }\n  ],\n  \"externalId\": \"Your id. Will merge with exisiting profile with same externalId\",\n  \"id\": \"Jarvi uuid. Will merge with exisiting profile with same id\",\n  \"location\": \"Rennes, France\",\n  \"headline\": \"Co-Founder Jarvi\",\n  \"currentCompanyName\": \"Jarvi\",\n  \"currentCompanyId\": \"713a8005-e54d-4ee3-b6a4-89b27167dde6\",\n  \"currentPosition\": \"Co-founder\",\n  \"<any custom field uuid>\": \"My custom field value for this profile\"\n}"

response = http.request(request)
puts response.read_body

{
  "message": "Profile saved successfully",
  "taskId": "0b538428-7652-4243-baaf-3867803d7007",
  "profileId": "d730cca9-d8b0-49e7-b2e0-c58c1bb7af9f"
}

{
  "message": "Error details",
  "taskId": "0b538428-7652-4243-baaf-3867803d7007"
}

{
  "message": "An error occured",
  "taskId": "0b538428-7652-4243-baaf-3867803d7007"
}

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": "quentin@jarvi.tech, quentin@decre.tech",
  "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": "713a8005-e54d-4ee3-b6a4-89b27167dde6",
  "currentPosition": "Co-founder",
  "<any custom field uuid>": "My custom field value for this profile"
}
'

import requests

url = "https://functions.prod.jarvi.tech/v1/public-api/rest/v2/applicants"

payload = {
    "referenceId": "JARVI001",
    "projectId": "713a8005-e54d-4ee3-b6a4-89b27167dde6",
    "firstName": "Quentin",
    "lastName": "Decré",
    "emailAddresses": "quentin@jarvi.tech, quentin@decre.tech",
    "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": "713a8005-e54d-4ee3-b6a4-89b27167dde6",
    "currentPosition": "Co-founder",
    "<any custom field uuid>": "My custom field value for this profile"
}
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    referenceId: 'JARVI001',
    projectId: '713a8005-e54d-4ee3-b6a4-89b27167dde6',
    firstName: 'Quentin',
    lastName: 'Decré',
    emailAddresses: 'quentin@jarvi.tech, quentin@decre.tech',
    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: '713a8005-e54d-4ee3-b6a4-89b27167dde6',
    currentPosition: 'Co-founder',
    '<any custom field uuid>': 'My custom field value for this profile'
  })
};

fetch('https://functions.prod.jarvi.tech/v1/public-api/rest/v2/applicants', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://functions.prod.jarvi.tech/v1/public-api/rest/v2/applicants",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'referenceId' => 'JARVI001',
    'projectId' => '713a8005-e54d-4ee3-b6a4-89b27167dde6',
    'firstName' => 'Quentin',
    'lastName' => 'Decré',
    'emailAddresses' => 'quentin@jarvi.tech, quentin@decre.tech',
    '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' => '713a8005-e54d-4ee3-b6a4-89b27167dde6',
    'currentPosition' => 'Co-founder',
    '<any custom field uuid>' => 'My custom field value for this profile'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://functions.prod.jarvi.tech/v1/public-api/rest/v2/applicants"

	payload := strings.NewReader("{\n  \"referenceId\": \"JARVI001\",\n  \"projectId\": \"713a8005-e54d-4ee3-b6a4-89b27167dde6\",\n  \"firstName\": \"Quentin\",\n  \"lastName\": \"Decré\",\n  \"emailAddresses\": \"quentin@jarvi.tech, quentin@decre.tech\",\n  \"phoneNumbers\": \"+33752626164,0240493773\",\n  \"linkedinUrl\": \"https://www.linkedin.com/in/quentindecre/\",\n  \"historyEntrySubject\": \"Application from website\",\n  \"historyEntryMessage\": \"The message of the historyentry you want to show in the profile’s Jarvi history\",\n  \"resumesFiles\": [\n    {\n      \"fileName\": \"cv.pdf\",\n      \"data\": \"data:@file/pdf;base64,JVBERi0......AABTLAAAAAA=\"\n    }\n  ],\n  \"files\": [\n    {\n      \"fileName\": \"motivation.docx\",\n      \"data\": \"data:@file/vnd.openxmlformats-officedocument.wordprocessingml.document;base64,UEsDBBQ......AABTLAAAAAA=\"\n    }\n  ],\n  \"externalId\": \"Your id. Will merge with exisiting profile with same externalId\",\n  \"id\": \"Jarvi uuid. Will merge with exisiting profile with same id\",\n  \"location\": \"Rennes, France\",\n  \"headline\": \"Co-Founder Jarvi\",\n  \"currentCompanyName\": \"Jarvi\",\n  \"currentCompanyId\": \"713a8005-e54d-4ee3-b6a4-89b27167dde6\",\n  \"currentPosition\": \"Co-founder\",\n  \"<any custom field uuid>\": \"My custom field value for this profile\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://functions.prod.jarvi.tech/v1/public-api/rest/v2/applicants")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"referenceId\": \"JARVI001\",\n  \"projectId\": \"713a8005-e54d-4ee3-b6a4-89b27167dde6\",\n  \"firstName\": \"Quentin\",\n  \"lastName\": \"Decré\",\n  \"emailAddresses\": \"quentin@jarvi.tech, quentin@decre.tech\",\n  \"phoneNumbers\": \"+33752626164,0240493773\",\n  \"linkedinUrl\": \"https://www.linkedin.com/in/quentindecre/\",\n  \"historyEntrySubject\": \"Application from website\",\n  \"historyEntryMessage\": \"The message of the historyentry you want to show in the profile’s Jarvi history\",\n  \"resumesFiles\": [\n    {\n      \"fileName\": \"cv.pdf\",\n      \"data\": \"data:@file/pdf;base64,JVBERi0......AABTLAAAAAA=\"\n    }\n  ],\n  \"files\": [\n    {\n      \"fileName\": \"motivation.docx\",\n      \"data\": \"data:@file/vnd.openxmlformats-officedocument.wordprocessingml.document;base64,UEsDBBQ......AABTLAAAAAA=\"\n    }\n  ],\n  \"externalId\": \"Your id. Will merge with exisiting profile with same externalId\",\n  \"id\": \"Jarvi uuid. Will merge with exisiting profile with same id\",\n  \"location\": \"Rennes, France\",\n  \"headline\": \"Co-Founder Jarvi\",\n  \"currentCompanyName\": \"Jarvi\",\n  \"currentCompanyId\": \"713a8005-e54d-4ee3-b6a4-89b27167dde6\",\n  \"currentPosition\": \"Co-founder\",\n  \"<any custom field uuid>\": \"My custom field value for this profile\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://functions.prod.jarvi.tech/v1/public-api/rest/v2/applicants")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"referenceId\": \"JARVI001\",\n  \"projectId\": \"713a8005-e54d-4ee3-b6a4-89b27167dde6\",\n  \"firstName\": \"Quentin\",\n  \"lastName\": \"Decré\",\n  \"emailAddresses\": \"quentin@jarvi.tech, quentin@decre.tech\",\n  \"phoneNumbers\": \"+33752626164,0240493773\",\n  \"linkedinUrl\": \"https://www.linkedin.com/in/quentindecre/\",\n  \"historyEntrySubject\": \"Application from website\",\n  \"historyEntryMessage\": \"The message of the historyentry you want to show in the profile’s Jarvi history\",\n  \"resumesFiles\": [\n    {\n      \"fileName\": \"cv.pdf\",\n      \"data\": \"data:@file/pdf;base64,JVBERi0......AABTLAAAAAA=\"\n    }\n  ],\n  \"files\": [\n    {\n      \"fileName\": \"motivation.docx\",\n      \"data\": \"data:@file/vnd.openxmlformats-officedocument.wordprocessingml.document;base64,UEsDBBQ......AABTLAAAAAA=\"\n    }\n  ],\n  \"externalId\": \"Your id. Will merge with exisiting profile with same externalId\",\n  \"id\": \"Jarvi uuid. Will merge with exisiting profile with same id\",\n  \"location\": \"Rennes, France\",\n  \"headline\": \"Co-Founder Jarvi\",\n  \"currentCompanyName\": \"Jarvi\",\n  \"currentCompanyId\": \"713a8005-e54d-4ee3-b6a4-89b27167dde6\",\n  \"currentPosition\": \"Co-founder\",\n  \"<any custom field uuid>\": \"My custom field value for this profile\"\n}"

response = http.request(request)
puts response.read_body

{
  "message": "Profile saved successfully",
  "taskId": "0b538428-7652-4243-baaf-3867803d7007",
  "profileId": "d730cca9-d8b0-49e7-b2e0-c58c1bb7af9f"
}

{
  "message": "Error details",
  "taskId": "0b538428-7652-4243-baaf-3867803d7007"
}

{
  "message": "An error occured",
  "taskId": "0b538428-7652-4243-baaf-3867803d7007"
}

You can use your public api key for this request. This allows you to do it directly in your website’s javascript code.

The maximum request size is 4.5MB. We recommend limiting your CV upload field size to a smaller size.

You can save everything on the profile using Custom fields. Click on this link to understand how to read and write information in custom fields.

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:

"quentin@jarvi.tech, quentin@decre.tech"

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

Show child attributes

files

object[]

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

Show child attributes

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"

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 (creates a work experience / position line on the profile). If not provided, will be extracted from the resume or Linkedin URL. Note: this does NOT link the profile as a contact of a company record. To attach a contact to a company, use the data.associations payload with a COMPANY_CONTACT association (see currentCompanyId).

Example:

"Jarvi"

currentCompanyId

string

deprecated

Deprecated: this field no longer creates a company association. To attach a profile as a contact of an existing company, pass a data object with an associations array, e.g. data: { associations: [{ associationType: "COMPANY_CONTACT", company: { jarviId: "" } }] }. Use company.jarviId for an existing Jarvi company, or company.externalId + name + statusId to upsert one.

Example:

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

currentPosition

string

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

Example:

"Co-founder"

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"

Generalities

Use cases

REST API Reference

GraphQL API Reference

[Application] Create or update

Authorizations

Body

Response