Delete Candidate

To delete an existing candidate or parts of a candidate profile, you will have to use the post method. The operation must be set to delete and scope to candidate.

For more details about the candidate-scope and available fields, please visit the candidate reference page.

Delete candidate example

To delete a candidate, and all of its data, you only need to provide a candidateId. Deleting candidates are done with a JSON object. Below you will see a small example of how the JSON-object is structured.

json
{
    "key": "YOUR_KEY",
    "scope": "candidate",
    "operation": "delete",
    "data": {
        "candidateId": 1209594
    }
}

Delete nested objects

To delete segments like an education, experience or a skill you must provide both the ID of the candidate with the nested object and the ID of the nested object you want to remove.

Below you will see an example of how to delete a single education on a specific candidate.

json
{
    "key": "YOUR_KEY",
    "scope": "candidate",
    "operation": "delete",
    "data": {
        "candidateId": 1209594,
        "education": {
            "id": 18491823
        }
    }
}

Remove fields

If you want to remove values of fields like, for instance, email or fields connected to nested objects, you will have to use the update-operation. Please visit Update candidate page for more information.