Move a candidate

You can move a candidate using the API.

Request

This method allows you to move candidates:

PUT /company/{companyID}/vacancy/{vacancyID}/applicant/{applicantID}

Parameters

Parameter	In	Type	Required	Description	Example
companyID	path	string	✔️	Company identifier	0GjqBwprWAdArDl4
vacancyID	path	string	✔️	Listing id	Vq5r6pYxam9AmMvP
applicantID	path	string	✔️	Candidate id	V41QG9eja5pK6Xev
column_id	payload	integer	✔️	Column id	13133

Request example

cURL request

curl -X PUT 'https://api.flatchr.io/company/0GjqBwprWAdArDl4/vacancy/Vq5r6pYxam9AmMvP/applicant/V41QG9eja5pK6Xev'
    -H "Authorization: Bearer {token}"
    -H 'Content-Type: application/json'
    -d '{"column_id":13133}'

Response

Name	Type	Description
id	string	Candidate identifier
vacancy_id	string	Listing identifier
column_id	integer	Identifier of the column where the candidate is located
created_at	timestamp	Candidate creation date
updated_at	timestamp	Candidate update date
status	integer	Candidate status
view	boolean	Whether the candidate's profile has been viewed
anonym	boolean	Whether the candidate is anonymized
external_id	string	External candidate identifier
candidate	candidate	Candidate information
column	string	Column to which the candidate was moved
vacancy	string	Name of the listing the candidate applied to
foreigner	boolean
applies	[applies]

Response example

{
    "id": "V41QG9aja5pK6Xev",
    "vacancy_id": "Vq1r6pYxam9AmMvP",
    "column_id": 1313,
    "score": 0,
    "comment": "",
    "created_at": 1643904014,
    "updated_at": 1645015716,
    "status": 1,
    "view": true,
    "anonym": false,
    "external_id": null,
    "candidate": {
        "id": "LrENkKc8mmn3xYBM",
        "email": "xxxxxxxx@gmail.com",
        "firstname": "XXXX",
        "lastname": "XXXX",
        "urls": {},
        "created_at": "2022-02-03T16:00:14.589Z",
        "phone": "+33 0 00 00 00 00",
        "consent": true
    },
    "column": {},
    "vacancy": {},
    "foreigner": false,
    "applies": [
        {
            "id": "Vq5r8pY1YgpAmMvP",
            "created_at": "2022-02-03T16:00:14.630Z",
            "vacancy_id": "Vq5rnpYxam9AmMvP",
            "offerer_id": "ZmbMGYdOZ1d3JPNx",
            "import": false
        }
    ]
}