Insert Candidate

Inserting candidates can easily be done through the Recruitment Manager API. For inserting candidates you will need to use the post method. The operation must be set to insert and scope to candidate.

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

Insert candidate example

Inserting 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": "insert",
    "data": {
        "firstName": "Johnny",
        "lastName": "Appleseed",
        "email": "johnny.appleseed@usa.gov",
        "gender": "male",
        "dob": "1974-09-26"
    }
}

When inserting new candidates, the fields firstName and lastName are required.

If the insert was validated and successful, a standard JSON object is returned with the given candidateId.

Below you will see what to expect if the candidate was inserted successfully.

json
{
    "success": true,
    "affectedRows": 1,
    "candidateId": 1209594
}

Insert of nested objects

Segments like education, certifications, skills and so on are inserted through nested objects.

To insert objects, like for instance education on a candidate, you must provide a candidateId.

The API will only allow 1 insert per request.

Below you will see an example of how to insert education on a candidate.

json
{
    "key": "YOUR_KEY",
    "scope": "candidate",
    "operation": "insert",
    "data": {
        "candidateId": 1209594,
        "education": {
            "schoolName": "University of Oslo",
            "type": "Social Science",
            "startDate": "2015-10-31",
            "endDate": "2017-10-31",
            "description": "PhD in Social Science, specialised in businesses economy",
            "degree": "PhD",
            "location": "Oslo, Norway"
        }
    }
}

When inserting nested objects successfully, the response will return an ID. In this case, for education, the successful response will output an educationId.

json
{
    "success": true,
    "affectedRows": 1,
    "educationId": 18491823
}

Notice

The correct method for adding nested objects, like education, experience, skills and so on, to candidates is done through the insert operation, not update.

The update operation is only used to update already inserted data. Please see the update candidate page for more information.