--- updatedAt: 2026-03-06T21:46:41.000Z agentTools: projectIndex: https://developers.hrflow.ai/llms.txt --- # 💾 Edit a Profile indexed in a Source This endpoint allows you to edit the of JSON of Profile. > 📘 Prerequisites > > 1. [✨ Create a Workspace](https://hrflow.ai/signup) > 2. [🔑 Get your API Key](https://developers.hrflow.ai/docs/api-authentification) > 3. [🔌 Create a Source](https://developers.hrflow.ai/docs/connectors-source) > 4. [💾 Index a Profile](https://developers.hrflow.ai/reference/index-a-profile) ## Request headers
Field Value
Content-Type application/json
X-API-KEY Your API Key.
X-USER-EMAIL Your HrFlow\.ai account's email.
# OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "website-api", "version": "2.3" }, "servers": [ { "url": "https://api.hrflow.ai/v1" } ], "components": { "securitySchemes": { "sec0": { "type": "apiKey", "in": "header", "name": "X-API-KEY", "x-default": "" }, "sec1": { "type": "apiKey", "in": "header", "name": "X-USER-EMAIL" } } }, "security": [ { "sec0": [], "sec1": [] } ], "paths": { "/profile/indexing": { "put": { "summary": "💾 Edit a Profile indexed in a Source", "description": "This endpoint allows you to edit the of JSON of Profile.", "operationId": "edit-a-profile", "requestBody": { "content": { "application/json": { "schema": { "type": "object", "required": [ "source_key", "profile" ], "properties": { "source_key": { "type": "string", "description": "Identification key of the Source attached to the Profile." }, "profile": { "type": "object", "description": "JSON of the Profile object.", "properties": { "key": { "type": "string", "description": "Identification key of the Profile." }, "reference": { "type": "string", "description": "Custom identifier of the Profile." }, "text_language": { "type": "string", "description": "Code language of the Profile." }, "text": { "type": "string", "description": "Full text of the Profile." }, "consent_algorithmic": { "type": "object", "description": "Algorithmic consent status of the Profile.", "properties": { "owner": { "type": "object", "properties": { "parsing": { "type": "boolean" }, "revealing": { "type": "boolean" }, "embedding": { "type": "boolean" }, "searching": { "type": "boolean" }, "scoring": { "type": "boolean" }, "upskilling": { "type": "boolean" } } }, "controller": { "type": "object", "properties": {} } } }, "created_at": { "type": "string", "description": "Creation date of the Profile.", "format": "date" }, "info": { "type": "object", "description": "Object containing the Profile's info.", "required": [ "full_name", "first_name", "last_name", "email" ], "properties": { "full_name": { "type": "string" }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "driving_license": { "type": "string", "description": "The type of the driver's license" }, "date_birth": { "type": "string", "format": "date" }, "location": { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string" }, "lat": { "type": "number", "description": "Must be a number between -90 and 90.", "format": "float" }, "lng": { "type": "number", "description": "Must be a number between -180 and 180.", "format": "float" } } }, "urls": { "type": "object", "description": "Profile social networks and URLs", "properties": { "from_resume": { "type": "array", "description": "Urls from resume.", "items": { "type": "string" } }, "linkedin": { "type": "string", "description": "Linkedin Profile Url." }, "twitter": { "type": "string", "description": "Twitter Profile Url." }, "facebook": { "type": "string", "description": "Facebook Profile Url." }, "github": { "type": "string", "description": "Github Profile Url." } } }, "picture": { "type": "string" }, "gender": { "type": "string" }, "summary": { "type": "string" } } }, "experiences_duration": { "type": "number", "description": "Total number of years of experience.", "format": "float" }, "educations_duration": { "type": "number", "description": "Total number of years of education.", "format": "float" }, "experiences": { "type": "array", "description": "List of experiences of the Profile.", "items": { "properties": { "company": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "location": { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string" }, "lat": { "type": "number", "description": "Must be a number between -90 and 90.", "format": "float" }, "lng": { "type": "number", "description": "Must be a number between -180 and 180.", "format": "float" } } }, "logo": { "type": "string", "description": "Url of the company logo" }, "date_start": { "type": "string", "description": "datetime ISO 8601" }, "date_end": { "type": "string", "description": "datetime ISO 8601" }, "skills": { "type": "array", "items": { "properties": { "name": { "type": "string", "description": "Name of the Skill." }, "type": { "type": "string", "description": "hard or soft skill." }, "value": { "type": "string", "description": "The value attached to the Skill." } }, "required": [ "name", "type" ], "type": "object" } }, "certifications": { "type": "array", "items": { "properties": { "name": { "type": "string", "description": "The name of the certification." }, "value": { "type": "string", "description": "The value attached to the certification." } }, "required": [ "name" ], "type": "object" } }, "courses": { "type": "array", "items": { "properties": { "name": { "type": "string", "description": "The name of the cource." }, "value": { "type": "string", "description": "The value attached to the course." } }, "required": [ "name" ], "type": "object" } }, "tasks": { "type": "array", "items": { "properties": { "name": { "type": "string", "description": "The name of the task." }, "value": { "type": "string", "description": "The value attached to the task." } }, "required": [ "name" ], "type": "object" } }, "languages": { "type": "array", "items": { "properties": { "name": { "type": "string", "description": "Name of the language." }, "value": { "type": "string", "description": "The value attached to the language." } }, "required": [ "name" ], "type": "object" } }, "interests": { "type": "array", "items": { "properties": { "name": { "type": "string", "description": "Name of the Tag." }, "value": { "type": "string", "description": "A value attached to the Tag." } }, "required": [ "name" ], "type": "object" } } }, "required": [ "company", "title", "description" ], "type": "object" } }, "educations": { "type": "array", "description": "List of educations of the Profile.", "items": { "properties": { "school": { "type": "string" }, "title": { "type": "string" }, "description": { "type": "string" }, "location": { "type": "object", "required": [ "text" ], "properties": { "text": { "type": "string" }, "lat": { "type": "number", "description": "Must be a number between -90 and 90.", "format": "float" }, "lng": { "type": "number", "description": "Must be a number between -180 and 180.", "format": "float" } } }, "logo": { "type": "string", "description": "Url of the school logo" }, "date_start": { "type": "string", "description": "datetime ISO 8601" }, "date_end": { "type": "string", "description": "datetime ISO 8601" }, "skills": { "type": "array", "items": { "properties": { "name": { "type": "string", "description": "Name of the Skill." }, "type": { "type": "string", "description": "hard or soft skill." }, "value": { "type": "string", "description": "The value attached to the Skill." } }, "required": [ "name", "type" ], "type": "object" } }, "certifications": { "type": "array", "items": { "properties": { "name": { "type": "string", "description": "The name of the certification." }, "value": { "type": "string", "description": "The value attached to the certification." } }, "required": [ "name" ], "type": "object" } }, "courses": { "type": "array", "items": { "properties": { "name": { "type": "string", "description": "The name of the cource." }, "value": { "type": "string", "description": "The value attached to the course." } }, "required": [ "name" ], "type": "object" } }, "tasks": { "type": "array", "items": { "properties": { "name": { "type": "string", "description": "The name of the task." }, "value": { "type": "string", "description": "The value attached to the task." } }, "required": [ "name" ], "type": "object" } }, "languages": { "type": "array", "items": { "properties": { "name": { "type": "string", "description": "Name of the language." }, "value": { "type": "string", "description": "The value attached to the language." } }, "required": [ "name" ], "type": "object" } }, "interests": { "type": "array", "items": { "properties": { "name": { "type": "string", "description": "Name of the Tag." }, "value": { "type": "string", "description": "A value attached to the Tag." } }, "required": [ "name" ], "type": "object" } } }, "required": [ "school", "title", "description" ], "type": "object" } }, "attachments": { "type": "array", "description": "List of documents attached to the Profile.", "items": { "properties": { "text": { "type": "string" }, "type": { "type": "string" }, "alt": { "type": "string" }, "file_size": { "type": "string" }, "file_name": { "type": "string" }, "original_file_name": { "type": "string" }, "extension": { "type": "string" }, "url": { "type": "string" } }, "required": [ "type", "alt", "file_name", "original_file_name", "extension" ], "type": "object" } }, "skills": { "type": "array", "description": "List of skills of the Profile.", "items": { "properties": { "name": { "type": "string", "description": "Name of the Skill." }, "type": { "type": "string", "description": "hard or soft skill." }, "value": { "type": "string", "description": "The value attached to the Skill." } }, "required": [ "name", "type" ], "type": "object" } }, "languages": { "type": "array", "description": "List of spoken languages of the Profile.", "items": { "properties": { "name": { "type": "string", "description": "Name of the language." }, "value": { "type": "string", "description": "The value attached to the language." } }, "required": [ "name" ], "type": "object" } }, "certifications": { "type": "array", "description": "List of certifications of the Profile.", "items": { "properties": { "name": { "type": "string", "description": "The name of the certification." }, "value": { "type": "string", "description": "The value attached to the certification." } }, "required": [ "name" ], "type": "object" } }, "courses": { "type": "array", "description": "List of courses of the Profile.", "items": { "properties": { "name": { "type": "string", "description": "The name of the cource." }, "value": { "type": "string", "description": "The value attached to the course." } }, "required": [ "name" ], "type": "object" } }, "tasks": { "type": "array", "description": "List of tasks of the Profile.", "items": { "properties": { "name": { "type": "string", "description": "The name of the task." }, "value": { "type": "string", "description": "The value attached to the task." } }, "required": [ "name" ], "type": "object" } }, "interests": { "type": "array", "description": "List of interests of the Profile.", "items": { "properties": { "name": { "type": "string", "description": "Name of the Tag." }, "value": { "type": "string", "description": "A value attached to the Tag." } }, "required": [ "name" ], "type": "object" } }, "tags": { "type": "array", "description": "List of tags of the Profile.", "items": { "properties": { "name": { "type": "string", "description": "The name of the Tag." }, "value": { "type": "string", "description": "The value attached to the Tag." } }, "required": [ "name" ], "type": "object" } }, "metadatas": { "type": "array", "description": "List of metadatas of the Profile.", "items": { "properties": { "name": { "type": "string", "description": "The name of the Metadata. Example: interview-note" }, "value": { "type": "string", "description": "The value attached to the Metadata. Example: \"Today, I met an amazing candidate...\"." } }, "required": [ "name" ], "type": "object" } }, "labels": { "type": "array", "description": "List of labels of the Profile.", "items": { "properties": { "board_key": { "type": "string" }, "job_reference": { "type": "string" }, "job_key": { "type": "string" }, "stage": { "type": "string" }, "date_stage": { "type": "string", "format": "date" }, "rating": { "type": "integer", "format": "int32" }, "date_rating": { "type": "string", "format": "date" } }, "required": [ "board_key", "job_reference", "job_key", "stage", "date_stage", "rating", "date_rating" ], "type": "object" } } } } } }, "examples": { "Request Example": { "value": { "source_key": "bab9f6d780cb610b70a417c10468887dc847e342", "profile": { "consent_algorithmic": {}, "info": { "full_name": "Elon Musk", "first_name": "Elon", "last_name": "Musk", "date_birth": "1971-06-28T00:00:00+0000", "email": "elon.musk@tesla.com", "phone": "+1125145212", "gender": "male", "urls": [], "picture": "https://thumbor.forbes.com/thumbor/960x0/https%3A%2F%2Fspecials-images.forbesimg.com%2Fimageserve%2F6176ddf8ec103b7f951e3a28%2FGERMANY-MEDIA-TESLA-AWARD%2F1960x0.jpg%3Ffit%3Dscale", "location": { "text": "San Francisco", "lat": 37.773972, "lng": -122.431297 }, "summary": "Elon Reeve Musk FRS is an entrepreneur and business magnate. He is the founder, CEO, and Chief Engineer at SpaceX; early stage investor, CEO, and Product Architect of Tesla, Inc.; founder of The Boring Company; and co-founder of Neuralink and OpenAI." }, "text": "In 1994, Musk held two internships in Silicon Valley during the summer: at energy storage startup Pinnacle Research Institute, which researched electrolytic ultracapacitors for energy storage, and at the Palo Alto-based startup Rocket Science Games.[36] In 1995, Musk was accepted to a Doctor of Philosophy (Ph.D.) program in materials science at Stanford University in California.[37] Musk attempted to get a job at Netscape but never received a response to his inquiries.[26] He dropped out of Stanford after two days, deciding instead to join the Internet boom and launch an Internet startup.[38]", "experiences": [ { "date_start": { "iso8601": "1995-01-01T00:00:00" }, "date_end": { "iso8601": "1999-07-01T00:00:00" }, "title": "Co-founder", "company": "Zip2", "description": "In 1995, Musk, Kimbal, and Greg Kouri founded web software company Zip2 with funds from angel investors. They housed the venture at a small rented office in Palo Alto.", "location": { "text": "San Francisco" }, "certifications": [], "courses": [], "tasks": [ { "name": "website development", "value": null } ], "skills": [ { "name": "coding", "value": null } ] } ], "experiences_duration": 4, "educations": [ { "date_start": { "iso8601": "1987-01-01T00:00:00" }, "date_end": { "iso8601": "1989-01-01T00:00:00" }, "title": "Bachelor of science", "school": "University of Pennsylvania", "description": "Bachelor of science degree in economics", "location": { "text": "Pennsylvania", "lat": 41.203323, "lng": -77.194527 }, "certifications": [], "courses": [ { "name": "general economics", "value": null } ], "tasks": [], "skills": [] } ], "educations_duration": 3, "certifications": [], "courses": [], "tasks": [], "skills": [ { "name": "coding", "value": null }, { "name": "entrepreneurship", "value": null }, { "name": "leadership", "value": null } ], "languages": [ { "name": "english", "value": null } ], "interests": [ { "name": "Football", "value": null } ], "tags": [], "metadatas": [], "labels": [], "attachments": [] } } } } } } }, "responses": { "200": { "description": "200", "content": { "application/json": { "examples": { "Edited": { "value": "{\n \"code\": 200,\n \"message\": \"Profile edited\",\n \"data\": {\n \"id\": id,\n \"key\": \"profile_key\",\n \"reference\": null,\n \"archive\": null,\n \"consent_algorithmic\": {\n \"owner\": {\n \"parsing\": true,\n \"revealing\": false,\n \"embedding\": true,\n \"searching\": false,\n \"scoring\": true,\n \"reasoning\": false\n },\n \"controller\": {\n \"parsing\": true,\n \"revealing\": false,\n \"embedding\": true,\n \"searching\": false,\n \"scoring\": true,\n \"reasoning\": false\n }\n },\n \"source\": {\n \"id\": id,\n \"key\": \"source_key\",\n \"name\": \"source name\",\n \"type\": \"api\",\n \"subtype\": \"http_api\"\n },\n \"updated_at\": \"2020-07-29T11:45:37+0000\",\n \"created_at\": \"2020-07-29T11:45:37+0000\",\n \"info\": {\n \"full_name\": \"Harry Potter\",\n \"first_name\": \"Harry\",\n \"last_name\": \"Potter\",\n \"date_birth\": \"1990-08-09T00:00:00+0000\"\n \"email\": \"harry.potter@gmail.com\",\n \"phone\": \"0202\",\n \"location\": {\n \"text\": null,\n \"lat\": null,\n \"lng\": null,\n \"gmaps\": null,\n \"fields\": null\n },\n \"urls\": [],\n \"picture\": null,\n \"gender\": null,\n \"summary\": \"Brief summary\"\n },\n \"text_language\": null,\n \"text\": null,\n \"experiences_duration\": 5,\n \"educations_duration\": 4,\n \"experiences\": [\n {\n \"key\": \"c4ade5ca8f3ebab04acc5e91fde5f9bb400d60cb\",\n \"title\": \"Lead\",\n \"description\": \"Developping.\",\n \"location\": {\n \"text\": \"Paris\",\n \"lat\": null,\n \"lng\": null,\n \"gmaps\": null,\n \"fields\": null\n },\n \"date_start\": \"2018-01-01T00:00:00\",\n \"date_end\": \"2018-07-01T00:00:00\",\n \"company\": \"Mathematic Departement\";\n \"certifications\": [{\n \"name\": \"certificate exp\",\n \"value\": null\n }],\n \"courses\": [{\n \"name\": \"cours exp\",\n \"value\": null\n }],\n \"tasks\": [{\n \"name\": \"tache exp\",\n \"value\": null\n }],\n \"skills\": [{\n \"name\": \"skill exp\",\n \"value\": null,\n \"type\" : \"hard\"\n }] \n }\n ],\n \"educations\": [\n {\n \"key\": \"3ea49b56c3dc6e4a0bde8bc2ca159560e1f57cb5\",\n \"title\": \"Mathematicien\",\n \"description\": \"Description\",\n \"location\": {\n \"text\": \"Scotland\",\n \"lat\": \"lat\",\n \"lng\": \"lng\",\n \"gmaps\": null,\n \"fields\": null\n },\n \"date_start\": \"2016-01-01T00:00:00\",\n \"date_end\": \"2018-01-01T00:00:00\",\n \"school\": \"University\",\n \"certifications\": [{\"name\": \"certificate edu\", \"value\": null}],\n \"courses\": [{\"name\": \"cours edu\", \"value\": null}],\n \"tasks\": [{\"name\": \"tache edu\", \"value\": null}],\n \"skills\": [{\"name\": \"skill edu\", \"type\" : \"hard\", \"value\": null}]\n }\n ],\n \"attachments\": [],\n \"certifications\": [\n {\"name\": \"certificate exp\", \"value\": null},\n {\"name\": \"certificate edu\", \"value\": null}\n ],\n \"courses\": [\n {\"name\": \"course exp\", \"value\": null},\n {\"name\": \"course edu\", \"value\": null}],\n \"tasks\": [\n {\"name\": \"task exp\", \"value\": null},\n {\"name\": \"task edu\", \"value\": null}],\n \"skills\": [\n {\"name\":\"manual skill\", \"type\": \"hard\", \"value\": null},\n {\"name\":\"Creative spirit\", \"type\": \"soft\", \"value\": null}, \n {\"name\":\"Writing skills\", \"type\": \"hard\", \"value\": null}, \n {\"name\":\"Communication\", \"type\": \"soft\", \"value\": null},\n {\"name\": \"skill edu\", \"type\": \"hard\", \"value\": null}\n {\"name\": \"skill exp\", \"type\": \"hard\", \"value\": null}],\n \"languages\": [{\"name\": \"english\", \"value\": null}],\n \"interests\": [{\"name\": \"football\", \"value\": null}],\n \"labels\": [{\"stage\": \"yes\", \"job_key\": \"job_key\"}],\n \"tags\": [{\"name\": \"archive\", \"value\": false}],\n \"metadatas\": []\n }\n}" } } } } }, "400": { "description": "400", "content": { "application/json": { "examples": { "Result": { "value": "{\n \"code\": 400,\n \"message\": \"Missing field:xxxxx in object:yyyy\"\n}" } }, "schema": { "type": "object", "properties": { "code": { "type": "integer", "example": 400, "default": 0 }, "message": { "type": "string", "example": "Missing field:xxxxx in object:yyyy" } } } } } } }, "deprecated": false } } }, "x-readme": { "headers": [], "explorer-enabled": true, "proxy-enabled": true }, "x-readme-fauxas": true } ```