Skip to main content
PUT
Ruby
This feature is currently available for the following integrations:You’d like to see this feature for another integration? Please reach out! We’re always happy to discuss extending our coverage.

Example Request Body

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 the status can only be updated to a different value if its current value is OPEN.

Available options:
COMPLETED,
CANCELLED,
OPEN
result_url
string<uri>
required
completed_at
string<date-time>

YYYY-MM-DDTHH:mm:ss.sssZ

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

Pattern: ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?)?Z?$
score
number<double>
max_score
number<double>
attributes
object[]

An array of additional attributes that you would like to submit as a part of the assessment result.

  • If an ATS only supports writing text attributes, we will transform non TEXT attributes into formatted plain text values.
attachments
object[]

An array of attachments containing the assessment result.

Maximum array length: 5
remote_fields
object

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

Response

PUT /assessment/orders/:assessment_order_id/result Positive response

status
string
required
Allowed value: "success"
data
object
required
warnings
object[]
required

These are the interaction warnings that are shown in the dashboard. They are meant to provide debug information to you. We recommend logging them to the console.