---
title: "assessment.update"
method: POST
path: "/assessment.update"
tags: ["Assessment"]
---

# assessment.update

`POST /assessment.update`

Update Ashby about the status of a started assessment.

`assessment_status` is required unless `cancelled_reason` is provided.

**Requires the [`candidatesWrite`](authentication#permissions-assessmentupdate) permission.**

## Request body

- AssessmentUpdateRequest
  - `assessment_id` string, required — Identifier of the assessment being updated
  - `timestamp` number, required — The timestamp in milliseconds since the unix epoch when the assessment update occurred
  - `assessment_status` AssessmentDataValue
    - `identifier` string, required — Uniquely identifies this field for this partner
    - `label` string, required — Label for the assessment data value to be displayed in the UI
    - `description` string, nullable — Description of the assessment data value, which may be displayed in the UI
    - `type` 'boolean_success' | 'numeric_score' | 'numeric_duration_milliseconds' | 'numeric_duration_minutes' | 'single_sign_on_url' | 'string' | 'numeric_timestamp_milliseconds' | 'url', required — The type of assessment data value
    - `value` union, required — The assessment data value, whose type depends on the type field
      - boolean
      - number
      - string
    - `isInternal` boolean, nullable — Whether the field was generated internally by Ashby
  - `assessment_profile_url` AssessmentDataValue
    - `identifier` string, required — Uniquely identifies this field for this partner
    - `label` string, required — Label for the assessment data value to be displayed in the UI
    - `description` string, nullable — Description of the assessment data value, which may be displayed in the UI
    - `type` 'boolean_success' | 'numeric_score' | 'numeric_duration_milliseconds' | 'numeric_duration_minutes' | 'single_sign_on_url' | 'string' | 'numeric_timestamp_milliseconds' | 'url', required — The type of assessment data value
    - `value` union, required — The assessment data value, whose type depends on the type field
      - boolean
      - number
      - string
    - `isInternal` boolean, nullable — Whether the field was generated internally by Ashby
  - `assessment_result` AssessmentDataValue
    - `identifier` string, required — Uniquely identifies this field for this partner
    - `label` string, required — Label for the assessment data value to be displayed in the UI
    - `description` string, nullable — Description of the assessment data value, which may be displayed in the UI
    - `type` 'boolean_success' | 'numeric_score' | 'numeric_duration_milliseconds' | 'numeric_duration_minutes' | 'single_sign_on_url' | 'string' | 'numeric_timestamp_milliseconds' | 'url', required — The type of assessment data value
    - `value` union, required — The assessment data value, whose type depends on the type field
      - boolean
      - number
      - string
    - `isInternal` boolean, nullable — Whether the field was generated internally by Ashby
  - `cancelled_reason` AssessmentDataValue
    - `identifier` string, required — Uniquely identifies this field for this partner
    - `label` string, required — Label for the assessment data value to be displayed in the UI
    - `description` string, nullable — Description of the assessment data value, which may be displayed in the UI
    - `type` 'boolean_success' | 'numeric_score' | 'numeric_duration_milliseconds' | 'numeric_duration_minutes' | 'single_sign_on_url' | 'string' | 'numeric_timestamp_milliseconds' | 'url', required — The type of assessment data value
    - `value` union, required — The assessment data value, whose type depends on the type field
      - boolean
      - number
      - string
    - `isInternal` boolean, nullable — Whether the field was generated internally by Ashby
  - `metadata` AssessmentDataValue[], nullable — Any other metadata about the assessment (e.g. ETA until complete). All assessment data should have unique identifiers.
    - `identifier` string, required — Uniquely identifies this field for this partner
    - `label` string, required — Label for the assessment data value to be displayed in the UI
    - `description` string, nullable — Description of the assessment data value, which may be displayed in the UI
    - `type` 'boolean_success' | 'numeric_score' | 'numeric_duration_milliseconds' | 'numeric_duration_minutes' | 'single_sign_on_url' | 'string' | 'numeric_timestamp_milliseconds' | 'url', required — The type of assessment data value
    - `value` union, required — The assessment data value, whose type depends on the type field
      - boolean
      - number
      - string
    - `isInternal` boolean, nullable — Whether the field was generated internally by Ashby

## Response `200`

Responses from the assessment.update endpoint

- union
  - AssessmentUpdateSuccessResponse
    - `success` true, required
    - `results` AssessmentUpdateResult, required
      - `assessmentId` string, required — The identifier of the assessment that was updated
  - ErrorResponse
    - `success` false, required
    - `errors` ErrorDetail[], required
      - `message` string, required
      - `parameter` string

---

[API](https://skmtc.net/ashbyhq/apis/ashby-api.md) · [All operations](https://skmtc.net/ashbyhq/apis/ashby-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ashbyhq/ashby-api/versions/778b919dc743/schema)