Orders and results
Update order result
Updates an assessment order result.
PUT
/
assessment
/
orders
/
{assessment_order_id}
/
result
Authorization
Header
Path
Body
curl --request PUT \
--url https://api.kombo.dev/v1/assessment/orders/{assessment_order_id}/result \
--header 'Authorization: <authorization>' \
--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"
}
]
}'
{
"status": "success",
"data": {}
}
Example Request Body
{
"status": "COMPLETED",
"result_url": "https://example.com",
"completed_at": "2023-04-04T00:00:00.000Z",
"score": 90,
"max_score": 100,
"attributes": [
{
"field": "remarks",
"value": "Test completed with passing score"
}
]
}
Authorizations
Authorization
string
headerrequiredCreate an API key on the Secrets page in the Kombo dashboard.
Headers
X-Integration-Id
string
requiredID of the integration you want to interact with.
Path Parameters
assessment_order_id
string
requiredPUT /assessment/orders/:assessment_order_id/result parameter
Body
application/json
status
enum<string>
requiredStatus of the assessment. Must be one of COMPLETE
or CANCELLED
.
Available options:
COMPLETED
, CANCELLED
, OPEN
result_url
string
requiredcompleted_at
string
requiredYYYY-MM-DDTHH:mm:ss.sssZ
score
number
max_score
number
attributes
object[]
Response
200 - application/json
status
enum<string>
requiredAvailable options:
success
data
object
requiredcurl --request PUT \
--url https://api.kombo.dev/v1/assessment/orders/{assessment_order_id}/result \
--header 'Authorization: <authorization>' \
--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"
}
]
}'
{
"status": "success",
"data": {}
}