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

# assessment.addCompletedToCandidate

`POST /assessment.addCompletedToCandidate`

Add a completed assessment to a candidate.

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

## Request body

- AssessmentAddCompletedToCandidateRequest
  - `candidateId` string, uuid, required — The id of the candidate to whom to add the completed assessment
  - `partnerId` string, uuid, required — The id of the partner adding the assessment
  - `assessment` CompletedCandidateAssessment, required
    - `assessmentTypeId` string, required — An identifier that uniquely identifies the assessment type
    - `assessmentId` string, required — An identifier that uniquely identifies the completed assessment
    - `assessmentName` string, required — The name of the assessment that was taken and displayed in the UI
    - `result` AssessmentDataValue, required
      - `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[], required — An array of metadata associated with this completed assessment
      - `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
  - `timestamp` integer, required — The timestamp in milliseconds since the unix epoch when the assessment was completed

## Response `200`

Responses from the assessment.addCompletedToCandidate endpoint

- union
  - AssessmentAddCompletedToCandidateSuccessResponse
    - `success` true, required
    - `results` Assessment, required
      - `id` string, uuid, required — The unique identifier for the assessment
      - `assessmentTypeId` string, required — An identifier that uniquely identifies the assessment type
      - `assessmentName` string, required — The name of the assessment that was taken and displayed in the UI
      - `assessmentId` string, nullable, required — An identifier that uniquely identifies the completed assessment
      - `result` AssessmentDataValue, required
        - `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[], required — An array of metadata associated with this completed assessment
        - `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
      - `applicationId` string, uuid, nullable, required — The id of the application associated with this assessment
      - `candidateId` string, uuid, nullable, required — The id of the candidate associated with this assessment
  - 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)