---
title: "Update order result"
method: PUT
path: "/assessment/orders/{assessment_order_id}/result"
tags: ["Unified ATS (Assessment & Background Check) API"]
---

# Update order result

`PUT /assessment/orders/{assessment_order_id}/result`

Updates an assessment or a background check order result.

### 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": "<YOUR_INTERNAL_ID_OF_THE_TEST>",
      "label": "Personality test",
      "score": {
        "value": 97,
        "max": 100
      },
      "status": "COMPLETED"
    }
  ],
  "attachments": [
    {
      "name": "Assessment Report.pdf",
      "data": "SGkgdGhlcmUsIEtvbWJvIGlzIGN1cnJlbnRseSBoaXJpbmcgZW5naW5lZXJzIHRoYXQgbG92ZSB0byB3b3JrIG9uIGRldmVsb3BlciBwcm9kdWN0cy4=",
      "content_type": "application/pdf"
    }
  ]
}
```

## Path parameters

- `assessment_order_id` string, required

## Headers

- `X-Integration-Id` string, required

## Request body

- PutAssessmentOrdersAssessmentOrderIdResultRequestBody
  - `status` 'COMPLETED' | 'CANCELLED' | 'OPEN', required — Status of the assessment. **Please note the `status` can only be updated to a different value if its current value is `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`.**
  - `score` number, double
  - `max_score` number, double
  - `attributes` union[] — 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.
    - union
      - object
        - `type` 'TEXT', required
        - `label` string, required
        - `value` string, required
      - object
        - `type` 'SUB_RESULT', required
        - `id` string, required
        - `label` string, required
        - `score` object, required
          - `value` number, double, required
          - `max` number, double, required
        - `status` 'COMPLETED' | 'CANCELLED', required
  - `attachments` object[] — An array of attachments containing the assessment result.
    - `name` string, required — 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` string — 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` string, uri — 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` string — 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.
  - `remote_fields` object — Additional fields that we will pass through to specific ATS systems.
    - `smartrecruiters` object
      - `scoreLabel` string — Value that we will pass through to SmartRecruiters' `scoreLabel` field.
    - `recruitee` object
      - `subtitle` string — Value that we will pass through to Recruitee's `subtitle` field on the assessment report.
    - `workday` object — Fields specific to Workday's `Assess_Candidate` [operation](https://community.workday.com/sites/default/files/file-hosting/productionapi/Recruiting/v46.0/Assess_Candidate.html).
      - `Assess_Candidate_Data` object — References to the Candidate Assessment to be created or modified along with the data to be used in the creation or modification.
        - `Candidate_Assessment_Data` object — The data used to create or modify a Candidate Assessment.
          - `Assess_Candidate_Test_Result_Data` object — Information on a set of Assessment Test Results used in concert with the Candidate Assessment.
            - `Assessment_Test_Status_Reference` object — A reference to the tenant supplied status for this Assessment Test Result. For example, if the test outcome was satisfactory or not.
              - …

## Response `200`

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

- PutAssessmentOrdersAssessmentOrderIdResultPositiveResponse
  - `status` 'success', required
  - `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.
    - `message` string, required

## Other responses

- `default` — The standard error response with the error codes for the ATS use case.

---

[API](https://skmtc.dev/kombo/apis/kombo-api.md) · [All operations](https://skmtc.dev/kombo/apis/kombo-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/kombo/kombo-api/revisions/3045d31e3493/schema)