Update Candidate

To update existing candidates you will need to use the post method. The operation must be set to update and scope to candidate.

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

Update candidate example

To update candidate data you must provide a candidateId. Updating 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": "update",
    "data": {
        "candidateId": 1209594,
        "title": "Missionary",
        "maritalStatus": "married"
    }
}

Updating nested objects

To update data on sub-segments on a candidate, like education, experience, skills and so on, you must define the object you want to update and the ID of both the candidate and the nested object you want to update.

If you need to obtain the required ID’s to update a candidate, you can use the GET request. Visit the get candidate page to learn more.

The API will only allow updating 1 nested object per API request.

Below you will see an example of how to update an existing education with new data.

php
{
    "key": "YOUR_KEY",
    "scope": "candidate",
    "operation": "update",
    "data": {
        "candidateId": 1209594,
        "education": {
            "id": 18491823,
            "location": "Fort Wayne, Indiana, U.S."
        }
    }
}

Please note!

You are only able to update existing sub-objects. You cannot, for instance, add a new education by updating a candidate. To insert a new education, experience, skill or so on, you will have to use the insert-operation.