> ## Documentation Index > Fetch the complete documentation index at: https://docs.kombo.dev/llms.txt > Use this file to discover all available pages before exploring further. # Update order result > Updates an assessment or a background check order result. 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 ```json theme={null} { "status": "COMPLETED", "score": 90, "max_score": 100, "result_url": "https://example.com", "completed_at": "2023-04-04T00:00:00.000Z", "attributes": [ { "type": "TEXT", "label": "Role fit", "value": "Excellent" }, { "type": "SUB_RESULT", "id": "", "label": "Personality test", "score": { "value": 97, "max": 100 }, "status": "COMPLETED" } ], "attachments": [ { "name": "Assessment Report.pdf", "data": "SGkgdGhlcmUsIEtvbWJvIGlzIGN1cnJlbnRseSBoaXJpbmcgZW5naW5lZXJzIHRoYXQgbG92ZSB0byB3b3JrIG9uIGRldmVsb3BlciBwcm9kdWN0cy4=", "content_type": "application/pdf" } ] } ``` ## OpenAPI ````yaml PUT /assessment/orders/{assessment_order_id}/result openapi: 3.1.0 info: title: Kombo API version: 1.0.0 servers: - url: https://api.kombo.dev/v1 description: Kombo EU API - url: https://api.us.kombo.dev/v1 description: Kombo US API security: - ApiKey: [] tags: - name: General - name: Kombo Connect description: >- Endpoints for Kombo Connect, our end-user-facing flow for setting up new integrations. - name: Unified HRIS API description: Unified endpoints to access all the HR concepts you might need. - name: Unified ATS API description: Unified endpoints to access all the ATS concepts you might need. - name: Unified ATS (Assessment & Background Check) API description: >- Unified endpoints to operate Assessments and Background Checks for many applicant tracking systems. - name: Unified LMS API description: Unified endpoints to access all the LMS concepts you might need. - name: AI Apply description: Endpoints for AI-powered job application features. - name: Custom Endpoints description: Custom integration-specific endpoints. paths: /assessment/orders/{assessment_order_id}/result: put: tags: - Unified ATS (Assessment & Background Check) API summary: Update order result description: >- Updates an assessment or a background check order result. 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 ```json { "status": "COMPLETED", "score": 90, "max_score": 100, "result_url": "https://example.com", "completed_at": "2023-04-04T00:00:00.000Z", "attributes": [ { "type": "TEXT", "label": "Role fit", "value": "Excellent" }, { "type": "SUB_RESULT", "id": "", "label": "Personality test", "score": { "value": 97, "max": 100 }, "status": "COMPLETED" } ], "attachments": [ { "name": "Assessment Report.pdf", "data": "SGkgdGhlcmUsIEtvbWJvIGlzIGN1cnJlbnRseSBoaXJpbmcgZW5naW5lZXJzIHRoYXQgbG92ZSB0byB3b3JrIG9uIGRldmVsb3BlciBwcm9kdWN0cy4=", "content_type": "application/pdf" } ] } ``` operationId: PutAssessmentOrdersAssessmentOrderIdResult parameters: - in: header name: X-Integration-Id schema: type: string description: ID of the integration you want to interact with. example: recruitee:HWUTwvyx2wLoSUHphiWVrp28 required: true - name: assessment_order_id in: path required: true description: PUT /assessment/orders/:assessment_order_id/result Parameter schema: $ref: >- #/components/schemas/PutAssessmentOrdersAssessmentOrderIdResultParameterAssessmentOrderId examples: example1: value: GRKdd9dibYKKCrmGRSMJf3wu requestBody: description: PUT /assessment/orders/:assessment_order_id/result Request body content: application/json: schema: $ref: >- #/components/schemas/PutAssessmentOrdersAssessmentOrderIdResultRequestBody examples: example1: value: status: COMPLETED score: 90 max_score: 100 result_url: https://example.com completed_at: '2023-04-04T00:00:00.000Z' attributes: - type: TEXT label: Role fit value: Excellent - type: SUB_RESULT id: label: Personality test score: value: 97 max: 100 status: COMPLETED attachments: - name: Assessment Report.pdf data: >- SGkgdGhlcmUsIEtvbWJvIGlzIGN1cnJlbnRseSBoaXJpbmcgZW5naW5lZXJzIHRoYXQgbG92ZSB0byB3b3JrIG9uIGRldmVsb3BlciBwcm9kdWN0cy4= content_type: application/pdf responses: '200': description: PUT /assessment/orders/:assessment_order_id/result Positive response content: application/json: schema: $ref: >- #/components/schemas/PutAssessmentOrdersAssessmentOrderIdResultPositiveResponse default: $ref: '#/components/responses/ErrorResponseATS' x-codeSamples: - lang: python label: PutAssessmentOrdersAssessmentOrderIdResult source: |- from kombo import Kombo from kombo.utils import parse_datetime with Kombo( integration_id="workday:HWUTwvyx2wLoSUHphiWVrp28", api_key="", ) as k_client: res = k_client.assessment.update_order_result(assessment_order_id="GRKdd9dibYKKCrmGRSMJf3wu", status="COMPLETED", result_url="https://example.com", completed_at=parse_datetime("2023-04-04T00:00:00Z"), score=90, max_score=100, attributes=[ { "type": "TEXT", "label": "Role fit", "value": "Excellent", }, { "type": "SUB_RESULT", "id": "", "label": "Personality test", "score": { "value": 97, "max": 100, }, "status": "COMPLETED", }, ], attachments=[ { "name": "Assessment Report.pdf", "content_type": "application/pdf", "data": "SGkgdGhlcmUsIEtvbWJvIGlzIGN1cnJlbnRseSBoaXJpbmcgZW5naW5lZXJzIHRoYXQgbG92ZSB0byB3b3JrIG9uIGRldmVsb3BlciBwcm9kdWN0cy4=", }, ]) # Handle response print(res) - lang: typescript label: PutAssessmentOrdersAssessmentOrderIdResult source: |- import { Kombo } from "@kombo-api/sdk"; const kombo = new Kombo({ integration_id: "workday:HWUTwvyx2wLoSUHphiWVrp28", api_key: "", }); async function run() { const result = await kombo.assessment.updateOrderResult({ assessment_order_id: "GRKdd9dibYKKCrmGRSMJf3wu", body: { status: "COMPLETED", result_url: "https://example.com", completed_at: new Date("2023-04-04T00:00:00Z"), score: 90, max_score: 100, attributes: [ { type: "TEXT", label: "Role fit", value: "Excellent", }, { type: "SUB_RESULT", id: "", label: "Personality test", score: { value: 97, max: 100, }, status: "COMPLETED", }, ], attachments: [ { name: "Assessment Report.pdf", content_type: "application/pdf", data: "SGkgdGhlcmUsIEtvbWJvIGlzIGN1cnJlbnRseSBoaXJpbmcgZW5naW5lZXJzIHRoYXQgbG92ZSB0byB3b3JrIG9uIGRldmVsb3BlciBwcm9kdWN0cy4=", }, ], }, }); console.log(result); } run(); - lang: ruby label: PutAssessmentOrdersAssessmentOrderIdResult source: >- require 'kombo' Models = ::Kombo::Models s = ::Kombo::Kombo.new( integration_id: 'workday:HWUTwvyx2wLoSUHphiWVrp28', security: Models::Shared::Security.new( api_key: '' ) ) res = s.assessment.update_order_result(assessment_order_id: 'GRKdd9dibYKKCrmGRSMJf3wu', body: Models::Shared::PutAssessmentOrdersAssessmentOrderIdResultRequestBody.new( status: Models::Shared::PutAssessmentOrdersAssessmentOrderIdResultRequestBodyStatus::COMPLETED, result_url: 'https://example.com', completed_at: DateTime.iso8601('2023-04-04T00:00:00Z'), score: 90.0, max_score: 100.0, attributes: [ Models::Shared::AttributeText.new( type: 'TEXT', label: 'Role fit', value: 'Excellent' ), Models::Shared::AttributeSubResult.new( type: 'SUB_RESULT', id: '', label: 'Personality test', score: Models::Shared::Score.new( value: 97.0, max: 100.0 ), status: Models::Shared::AttributeStatus::COMPLETED ), ], attachments: [ Models::Shared::PutAssessmentOrdersAssessmentOrderIdResultRequestBodyAttachment.new( name: 'Assessment Report.pdf', content_type: 'application/pdf', data: 'SGkgdGhlcmUsIEtvbWJvIGlzIGN1cnJlbnRseSBoaXJpbmcgZW5naW5lZXJzIHRoYXQgbG92ZSB0byB3b3JrIG9uIGRldmVsb3BlciBwcm9kdWN0cy4=' ), ] )) unless res.put_assessment_orders_assessment_order_id_result_positive_response.nil? # handle response end components: schemas: PutAssessmentOrdersAssessmentOrderIdResultParameterAssessmentOrderId: type: string PutAssessmentOrdersAssessmentOrderIdResultRequestBody: type: object properties: status: type: string enum: - COMPLETED - CANCELLED - OPEN description: >- Status of the assessment. **Please note the `status` can only be updated to a different value if its current value is `OPEN`.** result_url: type: string format: uri completed_at: description: >- YYYY-MM-DDTHH:mm:ss.sssZ **Please make sure this value is provided when the `status` is of the type `COMPLETED` or `CANCELLED`.** type: string format: date-time pattern: ^\d{4}-\d{2}-\d{2}(T\d{2}:\d{2}:\d{2}(\.\d+)?)?Z?$ externalDocs: url: >- https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString score: type: number format: double minimum: -1.7976931348623157e+308 max_score: type: number format: double minimum: -1.7976931348623157e+308 attributes: type: array items: anyOf: - type: object properties: type: type: string const: TEXT label: type: string value: type: string required: - type - label - value - type: object properties: type: type: string const: SUB_RESULT id: type: string label: type: string score: type: object properties: value: type: number format: double minimum: -1.7976931348623157e+308 max: type: number format: double minimum: 1 required: - value - max status: type: string enum: - COMPLETED - CANCELLED required: - type - id - label - score - status default: [] description: >- 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: type: array items: type: object properties: name: type: string description: >- File name of the file you want to upload. We recommend providing something human-readable with a valid file extension (like `Resume.pdf`), as this might be shown in your customer's system. content_type: type: string pattern: ^[\w.-]+\/[\w.-]+$ description: >- Content/MIME type of the file (e.g., `application/pdf`). If you provide `data`, this is required. If you provide `data_url`, this is optional and we'll attempt to use the `Content-Type` header of the response. **Note:** Please validate that the content type you provide is actually meaningful (and not something generic like [`application/octet-stream`](https://developer.mozilla.org/en-US/docs/Web/HTTP/Guides/MIME_types#applicationoctet-stream)). Especially when using object storage (like AWS S3), it's easy to accidentally discard the content types of user-provided files, so make sure to explicitly persist them when processing uploads from your users (see guides for [AWS](https://docs.aws.amazon.com/AmazonS3/latest/userguide/UsingMetadata.html#SysMetadata), [Google Cloud](https://cloud.google.com/storage/docs/metadata#content-type), and [Azure](https://learn.microsoft.com/en-us/rest/api/storageservices/put-blob#request-headers-all-blob-types)). data_url: type: string format: uri description: >- URL to the file you want to upload that can be accessed without authentication headers. We will download the content immediately when receiving the request, so the URL can be short-lived. If you're using an object storage provider (like AWS S3), we strongly recommend providing a signed URL for secure access (see guides for [AWS](https://docs.aws.amazon.com/AmazonS3/latest/userguide/ShareObjectPreSignedURL.html), [Google Cloud](https://cloud.google.com/storage/docs/access-control/signed-urls), and [Azure](https://learn.microsoft.com/en-us/azure/storage/common/storage-sas-overview)). **Note:** You must provide either this or `data_url`. We recommend `data_url` over `data` for most cases. data: type: string description: >- Base64-encoded contents of the file you want to upload. **Note:** You must provide either this or `data_url`. We recommend `data_url` over `data` for most cases. required: - name maxItems: 5 default: [] description: An array of attachments containing the assessment result. remote_fields: type: object properties: smartrecruiters: type: object properties: scoreLabel: type: string description: >- Value that we will pass through to SmartRecruiters' `scoreLabel` field. recruitee: type: object properties: subtitle: type: string description: >- Value that we will pass through to Recruitee's `subtitle` field on the assessment report. workday: type: object properties: Assess_Candidate_Data: type: object properties: Candidate_Assessment_Data: type: object properties: Assess_Candidate_Test_Result_Data: type: object properties: Assessment_Test_Status_Reference: type: object properties: Assessment_Status_ID: type: string required: - Assessment_Status_ID description: >- A reference to the tenant supplied status for this Assessment Test Result. For example, if the test outcome was satisfactory or not. description: >- Information on a set of Assessment Test Results used in concert with the Candidate Assessment. description: >- The data used to create or modify a Candidate Assessment. description: >- References to the Candidate Assessment to be created or modified along with the data to be used in the creation or modification. description: >- Fields specific to Workday's `Assess_Candidate` [operation](https://community.workday.com/sites/default/files/file-hosting/productionapi/Recruiting/v46.0/Assess_Candidate.html). description: Additional fields that we will pass through to specific ATS systems. required: - status - result_url PutAssessmentOrdersAssessmentOrderIdResultPositiveResponse: type: object properties: status: type: string const: success data: type: object warnings: type: array items: type: object properties: message: type: string required: - message description: >- 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. required: - status - data - warnings responses: ErrorResponseATS: description: The standard error response with the error codes for the ATS use case. content: application/json: schema: type: object properties: status: type: string enum: - error error: type: object properties: code: type: - string - 'null' enum: - PLATFORM.RATE_LIMIT_EXCEEDED - PLATFORM.CONCURRENCY_LIMIT_EXCEEDED - PLATFORM.INTEGRATION_NOT_FOUND - PLATFORM.INPUT_INVALID - PLATFORM.UNKNOWN_ERROR - PLATFORM.IP_NOT_WHITELISTED - PLATFORM.AUTHENTICATION_INVALID - PLATFORM.TASK_TIMED_OUT - INTEGRATION.PERMISSION_MISSING - INTEGRATION.AUTHENTICATION_INVALID - INTEGRATION.QA_FAILED - INTEGRATION.SETUP_SYNC_PENDING - INTEGRATION.SETUP_INCOMPLETE - INTEGRATION.INACTIVE - INTEGRATION.MODEL_NOT_AVAILABLE - INTEGRATION.MODEL_DISABLED - INTEGRATION.ACTION_NOT_AVAILABLE - INTEGRATION.ACTION_DISABLED - REMOTE.SERVICE_UNAVAILABLE - REMOTE.RATE_LIMIT_EXCEEDED - REMOTE.INPUT_INVALID - REMOTE.UNKNOWN_HTTP_ERROR - ATS.JOB_CLOSED - ATS.APPLICATION_ALREADY_EXISTS example: ATS.JOB_CLOSED description: >- Some errors include an error code that can be used to identify their cause. See the [Error Handling Docs](https://docs.kombo.dev/guides/errors) for more information. For your error handling logic please use the error `code` instead of other properties (e.g. message, http status code, ...). title: type: - string - 'null' description: A static, human-readable label. message: type: string description: >- A dynamic, detailed description of what went wrong in this specific instance. log_url: type: - string - 'null' format: uri description: >- The log page in the Kombo UI lists every interaction with full details. If you need assistance, share that link with our support team. required: - code - title - message - log_url description: Error details with structured code for programmatic handling. required: - status - error examples: Error Response: description: >- When building error handling logic, always use the `code` field to identify specific error types programmatically. See the complete list of error codes in the [docs](https://docs.kombo.dev/guides/errors). value: status: error error: code: INTEGRATION.MODEL_NOT_AVAILABLE title: >- This data model isn't supported for the selected integration. message: >- The "employees" model is not yet available for Greenhouse. Please reach out to Kombo if you need this functionality. log_url: https://app.kombo.dev/my-prod/logs?interactionId=123456 Minimal Error Response: description: >- The "message" is always required while other fields can also be `null`. See the [docs](https://docs.kombo.dev/guides/errors) for more information. value: status: error error: code: null title: null message: The message is always in the response. log_url: null securitySchemes: ApiKey: type: http scheme: bearer description: >- Create an API key on the [Secrets](https://app.kombo.dev/secrets) page in the Kombo dashboard. ````