Archive a candidate

You can archive a candidate using the API.

Request

This method allows you to archive candidates:

DELETE /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

Request example

cURL request

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

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
score	integer	Candidate score
comment	string	Candidate cover letter
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	boolean	External candidate identifier
candidate	candidate	Candidate information
vacancy	vacancy	The job listing the candidate applied to
foreigner	boolean
applies	[applies]

Response example

{
    "id": "gQayv9LNBcd6LXE4",
    "vacancy_id": "Vq5r6pYxzm9AmMvP",
    "column_id": 1314,
    "score": 0,
    "comment": "",
    "created_at": 1645022213,
    "updated_at": 1645022486,
    "status": 0,
    "view": true,
    "anonym": false,
    "external_id": null,
    "candidate": {
        "id": "G6KzqPnN6Yn3nm0l",
        "email": null,
        "firstname": "XXXXX",
        "lastname": "XXXXX",
        "urls": {},
        "created_at": "2022-02-16T14:36:53.745Z",
        "phone": null,
        "consent": true
    },
    "foreigner": false,
    "datas": []
}