Add meta information

You can add meta information to a candidate using the API.

Note

This feature is only available for clients who have subscribed to the Premium CV Library option.

Request

This method allows you to add additional information to a candidate's profile:

POST /company/{companyID}/search/candidate

Parameters

Parameter	In	Type	Required	Description	Example
companyId	path	string	✔️	Company identifier	Wy3EOp2NP3p1KMq8
app_name	payload	string		Name of the application inserting the data (e.g. if used by a CV parsing application)	HRMatch
reference	payload	string	✔️	email of the candidate to update	john.doe@mail.fr
type	payload	string		Data type	applicants
value	payload	object	✔️	An object containing the data to add to the candidate profile	{"lastname": "Doe"}

Request example

cURL request

curl -X POST https://api.flatchr.io/company/Wy3EOp2NP3p1KMq8/search/applicants
    -H "Authorization: Bearer {token}"
    -H 'Content-Type: application/json'
    -d '{"lastname":"{name}"}'

Response

Name	Type	Description
statuscode	string	HTTP status
message	message	Message

Response example

{
    "statusCode": 200,
    "message": {
        "resource_type": "attribute",
        "action": "created"
    }
}