PUT
/
assessment
/
orders
/
{assessment_order_id}
/
result
curl --request PUT \
  --url https://api.kombo.dev/v1/assessment/orders/{assessment_order_id}/result \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Integration-Id: <x-integration-id>' \
  --data '{
  "status": "COMPLETED",
  "score": 90,
  "max_score": 100,
  "result_url": "https://example.com",
  "completed_at": "2023-04-04T00:00:00.000Z",
  "attributes": [
    {
      "field": "remarks",
      "value": "Test completed with passing score"
    }
  ],
  "sub_results": [
    {
      "id": "xyz",
      "title": "Title of the test",
      "score": 75,
      "max_score": 100,
      "status": "COMPLETED"
    }
  ]
}'
{
  "status": "success",
  "data": {}
}

​
Example Request Body

{
  "status": "COMPLETED",
  "score": 90,
  "max_score": 100,
  "result_url": "https://example.com",
  "completed_at": "2023-04-04T00:00:00.000Z",
  "attributes": [
    {
      "field": "remarks",
      "value": "Test completed with passing score"
    }
  ],
  "sub_results": [
    {
      "id": "xyz",
      "title": "Title of the test",
      "score": 75,
      "max_score": 100,
      "status": "COMPLETED"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Create an API key on the Secrets page in the Kombo dashboard.

Headers

​
X-Integration-Id
string
required

ID of the integration you want to interact with.

Path Parameters

​
assessment_order_id
string
required

PUT /assessment/orders/:assessment_order_id/result parameter

Body

application/json
PUT /assessment/orders/:assessment_order_id/result request body
​
status
enum<string>
required

Status of the assessment.

Please note only the orders with the status of OPEN can be updated.

Available options:
COMPLETED,
CANCELLED,
OPEN
​
result_url
string
required
​
completed_at
string

YYYY-MM-DDTHH:mm:ss.sssZ

Please make sure this value is provided when the status is of the type COMPLETED or CANCELLED.

​
score
number
​
max_score
number
​
attributes
object[]
​
sub_results
object[]
​
remote_fields
object

Additional fields that we will pass through to specific ATS systems.

Response

200
application/json
PUT /assessment/orders/:assessment_order_id/result Successful response
​
status
enum<string>
required
Available options:
success
​
data
object
required