Add Comments to assessment orders

πŸ›‘

Assessment API Sunset

This API has been deprecated since September 4, 2023. The sunset date is June 10, 2024. If you are an assessment provider or looking to build an assessment integration with SmartRecruiters, please consider using the new Assessment API (2021).

The assessment API allows you to add comments to an order at any point in time. You can manage these comments through the endpoint: /assessments/{assessmentOrderId}/comments

Add comments to an assessment order

The AssessmentComment object can be used to post a new comment about a particular assessment if need be. Here is a sample HTTP POST request that posts a comment:

curl -i
     -H "X-SmartToken:abc123"
     -H "Content-Type: application/json;charset=utf-8"
     -d @body.json
     -X POST
     https://api.smartrecruiters.com/v1/assessments/511a3942300469a9c33819d1/comments

body.json:

{
    "message": "Candidate is not responding to emails and is not answering the calls. We can't reach him.",
    "author": {
        "firstName": "John",
        "lastName": "Mnemonic",
        "email": "[email protected]",
        "phone": "(123) 321 32 1231"
    }
}

Note: Up to 100 comments can be added to a single assessment order.

Check comments on an assessment order

All comments sent to a particular assessment can be checked using the following GET request:

curl -i
     -H "X-SmartToken: abc123"
     -X GET
     https://api.smartrecruiters.com/v1/assessments/511a3942300469a9c33819d1/comments

Response Body:

{
    "limit": 10,
    "offset": 0,
    "totalFound": 2,
    "content": [
        {
            "id": "211a3942300469a9c33819d1",
            "createDate": "2013-03-08T09:22:01.605+0000",
            "message": "We are starting work on this. This assessment should take about 3 business days.",
            "author": {
                "firstName": "John",
                "lastName": "Mnemonic",
                "email": "[email protected]",
                "phone": "(123) 321 32 1231"
            }
        },
        {
            "id": "333a3942300469a9c33819aa",
            "createDate": "2013-03-08T09:22:01.605+0000",
            "message": "Candidate is not responding to emails and is not answering the calls. We can't reach him.",
            "author": {
                "firstName": "John",
                "lastName": "Mnemonic",
                "email": "[email protected]",
                "phone": "(123) 321 32 1231"
            }
        }
    ]
}