PUT: /profile/indexing

This endpoint allows you to update a Profile object.

Please find below an example of Profile json to update.

{
"consent_algorithmic": {
"owner": {
"parsing": true,
"revealing": false,
"embedding": true,
"searching": false,
"scoring": true,
"reasoning": false
},
"controller": {
"parsing": true,
"revealing": false,
"embedding": true,
"searching": false,
"scoring": true,
"reasoning": false
}
},
"info" : {
"full_name":"Harry Potter",
"first_name": "Harry",
"last_name": "Potter",
"email":"harry.potter@gmail.com",
"phone":"0202",
"gender": null,
"urls": {
"from_resume": [],
"linkedin":"",
"twitter":"",
"facebook":"",
"github":""},
"picture":null,
"location":{"text": null},
"summary": "Brief summary"
},
"experiences": [{
"date_start": {"iso8601": "2018-01-01T00:00:00"},
"date_end": {"iso8601": "2018-07-01T00:00:00"},
"title": "Lead",
"company": "Mathematic Departement",
"location": {"text":"Paris"},
"description": "Developping."
}],
"experiences_duration":5,
"educations": [{
"date_start": {"iso8601": "2016-01-01T00:00:00"},
"date_end": {"iso8601": "2018-01-01T00:00:00"},
"title": "Mathematicien",
"school": "University",
"description": "Description",
"location": {"text":"Scotland", "lat":"lat", "lng": "lng"}
}],
"educations_duration":4,
"skills": [{"name":"manual skill", "type": "hard", "value": null},
{"name":"Creative spirit", "type": "soft","value": null},
{"name":"Writing skills", "type": "hard","value": null},
{"name":"Communication", "type": "soft","value": null}],
"languages" : [{"name":"english", "value": null}],
"interests": [{"name":"football", "value": null}],
"tags":[{"name":"archive", "value": false}],
"metadatas":[],
"labels":[
{
"stage": "yes",
"job_key": job_key,
"board_key": board_key,
"date_stage": "2020-07-07T00:00:00",
"rating": 5,
"date_rating" : "2020-07-06T00:00:00"
}
],
"attachments": []
}

put
/profile/indexing

https://api.hrflow.ai/v1/profile/indexing
This endpoint allows you to put Json Profile.
Request
Response
Request
Headers
X-API-KEY
required
string
Authentication token
X-USER_EMAIL
required
string
User's email
Body Parameters
source_key
required
string
The key of the source in which the Profile will be added
key
required
string
The key of the Profile update
consent_algorithmic
required
object
The user's algorithmic consent, it tells to the algorithm what are the allowed actions in order to use personal data
created_at
required
string
The Creation datetime in iso format
reference
optional
string
Profile's reference, it is a unique for a given source
info
required
array
Profile's related info : { "full_name": XXX, "first_name": XXX, "last_name": XXX, "email": XXX, "phone": 20202020, "gender": F, "picture": "location": {"text": null}, "summary": "Brief summary", "urls" : {...} }
educations
required
array
Profile's educations: [{ "title" : "EDU1", "school": "HrFlow Academy", "description": "Edu description", "location": { "text": "Paris", "lat" : 48.8534, "lng": 2.3488}, "date_start": { "iso8601": "2016-01-01T00:00:00"}, "date_end": {"iso8601": "2018-01-01T00:00:00"} }, ...]
educations_duration
required
number
The Education's duration
experiences
required
array
Profile's experiences: [{ "title": "EXP1", "company": "HrFlow" "description": "Exp description", "location": { "text": "Paris", "lat": 48.8534 , "lng": 2.3488}, "date_start": {"iso8601": "2018-01-01T00:00:00"}, "date_end": {"iso8601": "2018-07-01T00:00:00"} }, ...]
experiences_duration
required
number
The profile's seniority.
text
required
string
A text to include with a Profile, it describes concisely each experience and education.
text_language
required
string
The language of the original text, it is in ISO 639-1 format
skills
required
array
Profile's skills : [{ "name": "Python", "type": "hard", "value": 0.6}, ...]
languages
required
array
The Profile's languages [{"name": "english", "value":1}, ...]
interests
required
array
The Profile's interests [{"name": "e-sport", "value": 0.8},...]
labels
required
array
The Profile's labels [{ "stage": "yes", "job_key": job_key, "board_key": board_key, "date_stage": "2020-07-07T00:00:00", "rating": 5, "date_rating" : "2020-07-06T00:00:00"}, ...]
tags
required
array
The Profile's tags [{"name": "archive", "value": true}, ...]
metadatas
required
array
Profile's metadatas [{"name": "meta", "value": "file"}, ...]
attachments
required
array
Profile's attachments
Response
201: Created
Cake successfully retrieved.
{
"code": 200,
"message": "Profile edited",
"data": {
"id": id,
"key": "profile_key",
"reference": null,
"archive": null,
"consent_algorithmic": {
"owner": {
"parsing": true,
"revealing": false,
"embedding": true,
"searching": false,
"scoring": true,
"reasoning": false
},
"controller": {
"parsing": true,
"revealing": false,
"embedding": true,
"searching": false,
"scoring": true,
"reasoning": false
}
},
"source": {
"id": id,
"key": "source_key",
"name": "source name",
"type": "api",
"subtype": "http_api"
},
"updated_at": "2020-07-29T11:45:37+0000",
"created_at": "2020-07-29T11:45:37+0000",
"info": {
"full_name": "Harry Potter",
"first_name": "Harry",
"last_name": "Potter",
"email": "harry.potter@gmail.com",
"phone": "0202",
"location": {
"text": null,
"lat": null,
"lng": null,
"gmaps": null,
"fields": null
},
"urls": {
"from_resume": [],
"linkedin": "",
"twitter": "",
"facebook": "",
"github": "",
"picture": ""
},
"picture": null,
"gender": null,
"summary": "Brief summary"
},
"text_language": null,
"text": null,
"experiences_duration": 5,
"educations_duration": 4,
"experiences": [
{
"key": "c4ade5ca8f3ebab04acc5e91fde5f9bb400d60cb",
"title": "Lead",
"description": "Developping.",
"location": {
"text": "Paris",
"lat": null,
"lng": null,
"gmaps": null,
"fields": null
},
"date_start": "2018-01-01T00:00:00",
"date_end": "2018-07-01T00:00:00",
"hard_skills": null,
"soft_skills": null,
"company": "Mathematic Departement"
}
],
"educations": [
{
"key": "3ea49b56c3dc6e4a0bde8bc2ca159560e1f57cb5",
"title": "Mathematicien",
"description": "Description",
"location": {
"text": "Scotland",
"lat": "lat",
"lng": "lng",
"gmaps": null,
"fields": null
},
"date_start": "2016-01-01T00:00:00",
"date_end": "2018-01-01T00:00:00",
"hard_skills": null,
"soft_skills": null,
"school": "University"
}
],
"attachments": [],
"skills": [
{
"name": "manual skill",
"type": "hard",
"value": null
},
{
"name": "Creative spirit",
"type": "soft",
"value": null
},
{
"name": "Writing skills",
"type": "hard",
"value": null
},
{
"name": "Communication",
"type": "soft",
"value": null
}
],
"languages": [
{
"name": "english",
"value": null
}
],
"interests": [
{
"name": "football",
"value": null
}
],
"labels": [
{
"stage": "yes",
"job_key": "job_key"
}
],
"tags": [
{
"name": "archive",
"value": false
}
],
"metadatas": []
}
}
400: Bad Request
Could not find a cake matching this query.
{
"code": 400,
"message": "Invalid source fields"
}

date_start and date_end in Experience and Education are objects, or conversely the GET endpoint sends you back date_start and date_end as string

{"iso8601" : "2018-01-01T00:00:00"}
Python
Javascript
Python
from hrflow import Hrflow
client = Hrflow(api_secret="Your API Key", api_user="Your API user email")
data = {
"consent_algorithmic": {
"owner": {
"parsing": True,
"revealing": True,
"embedding": True,
"searching": True,
"scoring": True,
"reasoning": True
},
"controller": {
"parsing": True,
"revealing": False,
"embedding": True,
"searching": False,
"scoring": True,
"reasoning": False
}
},
"info" : {
"full_name":"Harry Potter",
"first_name": "Harry",
"last_name": "Potter",
"email":"harry.potter@gmail.com",
"phone":"0202",
"gender": None,
"urls": {
"from_resume": [],
"linkedin":"",
"twitter":"",
"facebook":"",
"github":""},
"picture":None,
"location":{"text": None},
"summary": "Brief summary"
},
"experiences": [{
"date_start": {"iso8601": "2018-01-01T00:00:00"},
"date_end": {"iso8601": "2018-07-01T00:00:00"},
"title": "Lead",
"company": "Mathematic Departement",
"location": {"text":"Paris"},
"description": "Developping."
}],
"experiences_duration":5,
"educations": [{
"date_start": {"iso8601": "2016-01-01T00:00:00"},
"date_end": {"iso8601": "2018-01-01T00:00:00"},
"title": "Mathematicien",
"school": "University",
"description": "Description",
"location": {"text":"Scotland", "lat":"lat", "lng": "lng"}
}],
"educations_duration":4,
"skills": [{"name":"manual skill", "type": "hard", "value": None},
{"name":"Creative spirit", "type": "soft","value": None},
{"name":"Writing skills", "type": "hard","value": None},
{"name":"Communication", "type": "soft","value": None}],
"languages" : [{"name":"english", "value": None}],
"interests": [{"name":"football", "value": None}],
"tags":[{"name":"archive", "value": False}],
"metadatas":[],
"labels":[
{
"stage": "yes",
"job_key": job_key,
"board_key": board_key,
"date_stage": "2020-07-07T00:00:00",
"rating": 5,
"date_rating" : "2020-07-06T00:00:00"
}
],
"attachments": []
};
client.profile.indexing.edit(source_key="source_key", key="profile_key", profile_json=data)
Javascript
import Hrflow from 'hrflow';
const client = new Hrflow({
api_secret: 'Your API Key',
api_user: 'Your API user email',
});
const data = {
'consent_algorithmic': {
'owner': {
'parsing': true,
'revealing': false,
'embedding': true,
'searching': false,
'scoring': true,
'reasoning': false
},
'controller': {
'parsing': true,
'revealing': false,
'embedding': true,
'searching': false,
'scoring': true,
'reasoning': false
}
},
'info' : {
'full_name':'Harry Potter',
'first_name': 'Harry',
'last_name': 'Potter',
'email':'harry.potter@gmail.com',
'phone':'0202',
'gender': null,
'urls': {
'from_resume': [],
'linkedin': '',
'twitter': '',
'facebook': '',
'github': ''},
'picture':null,
'location':{'text': null},
'summary': 'Brief summary'
},
'experiences': [{
'date_start': {'iso8601': '2018-01-01T00:00:00'},
'date_end': {'iso8601': '2018-07-01T00:00:00'},
'title': 'Lead',
'company': 'Mathematic Departement',
'location': {'text':'Paris'},
'description': 'Developping.'
}],
'experiences_duration':5,
'educations': [{
'date_start': {'iso8601': '2016-01-01T00:00:00'},
'date_end': {'iso8601': '2018-01-01T00:00:00'},
'title': 'Mathematicien',
'school': 'University',
'description': 'Description',
'location': {'text':'Scotland', 'lat':'lat', 'lng': 'lng'}
}],
'educations_duration':4,
'skills': [{'name':'manual skill', 'type': 'hard', 'value': null},
{'name':'Creative spirit', 'type': 'soft','value': null},
{'name':'Writing skills', 'type': 'hard','value': null},
{'name':'Communication', 'type': 'soft','value': null}],
'languages' : [{'name':'english', 'value': null}],
'interests': [{'name':'football', 'value': null}],
'tags':[{'name':'archive', 'value': false}],
'metadatas':[],
'labels':[{'stage':'yes', 'job_key':'job_key'}],
'attachments': []
};
client.profile.indexing.edit(
'source_key',
'profile_key',
data
).then(response => {
console.log(respone);
// ...
});