---
title: "assessment.cancel (Implemented by Partner)"
method: POST
path: "/assessment.cancel"
tags: ["Assessment"]
---

# assessment.cancel (Implemented by Partner)

`POST /assessment.cancel`

(Optional) Cancels an assessment. Implemented by the partner, called by Ashby.

## Request body

- object
  - `assessment_id` string, uuid, required — The id of the started assessment to cancel

## Response `200`

Responses for the assessment.cancel endpoint

- union
  - AssessmentStartResponse
    - `success` boolean, required
    - `results` object, required
      - `assessment_id` string, required
      - `update_request` OverlayAssessmentUpdateRequest
        - `assessment_id` string, uuid, required — Identifier of the assessment being updated
        - `timestamp` integer, required — The timestamp in milliseconds since the unix epoch, when the update occurred
        - `assessment_status` object — The current status of the assessment. Setting this with a value of "Started" will signal Ashby to store the timestamp the assessment started. Required when `cancelled_reason` is not set.
          - `identifier` string, required — Uniquely identifies this field, for this partner
          - `label` string, required — Label for the assessment metadata to be displayed in the UI
          - `description` string — Description of the assessment metadata, which may be displayed in the UI
          - `type` 'numeric_score' | 'numeric_duration_minutes' | 'url' | 'string' | 'boolean_success', required — The type of the value. Please reach out if you'd like us to support a new type!
          - `value` union, required
            - string
            - number
            - boolean
        - `assessment_profile_url` object — The url back to the assessment/candidate on the partner's website. This value should always be of type url. Required when `assessment_result` is set.
          - `identifier` string, required — Uniquely identifies this field, for this partner
          - `label` string, required — Label for the assessment metadata to be displayed in the UI
          - `description` string — Description of the assessment metadata, which may be displayed in the UI
          - `type` 'numeric_score' | 'numeric_duration_minutes' | 'url' | 'string' | 'boolean_success', required — The type of the value. Please reach out if you'd like us to support a new type!
          - `value` union, required
            - string
            - number
            - boolean
        - `assessment_result` object — The result of the assessment. Sending an update with this field will signal to Ashby that the assessment is complete.
          - `identifier` string, required — Uniquely identifies this field, for this partner
          - `label` string, required — Label for the assessment metadata to be displayed in the UI
          - `description` string — Description of the assessment metadata, which may be displayed in the UI
          - `type` 'numeric_score' | 'numeric_duration_minutes' | 'url' | 'string' | 'boolean_success', required — The type of the value. Please reach out if you'd like us to support a new type!
          - `value` union, required
            - string
            - number
            - boolean
        - `cancelled_reason` object — The reason the assessment was cancelled. This field will signal to Ashby that the assessment is cancelled.
          - `identifier` string, required — Uniquely identifies this field, for this partner
          - `label` string, required — Label for the assessment metadata to be displayed in the UI
          - `description` string — Description of the assessment metadata, which may be displayed in the UI
          - `type` 'numeric_score' | 'numeric_duration_minutes' | 'url' | 'string' | 'boolean_success', required — The type of the value. Please reach out if you'd like us to support a new type!
          - `value` union, required
            - string
            - number
            - boolean
        - `metadata` OverlayAssessmentDataValue[] — 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 metadata to be displayed in the UI
          - `description` string — Description of the assessment metadata, which may be displayed in the UI
          - `type` 'numeric_score' | 'numeric_duration_minutes' | 'url' | 'string' | 'boolean_success', required — The type of the value. Please reach out if you'd like us to support a new type!
          - `value` union, required
            - string
            - number
            - boolean
  - OverlayErrorResponse
    - `success` boolean, required — Whether the response is considered successful.
    - `errors` string[], required — A list of error codes
    - `errorInfo` object, required — A single error code and additional error information
      - `code` string, required
      - `message` string
      - `requestId` string — Opaque identifier for the API request, which can be provided to Ashby support to help them diagnose the issue
      - `meta` object

---

[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/revisions/778b919dc743/schema)