---
title: "Update an order"
method: PATCH
path: "/assessment/{connection_id}/order/{id}"
tags: ["assessment", "order"]
---

# Update an order

`PATCH /assessment/{connection_id}/order/{id}`

## Path parameters

- `connection_id` string, required
- `id` string, required

## Query parameters

- `fields` string[]
- `raw` string

## Request body

- AssessmentOrder
  - `id` string
  - `created_at` string, date-time
  - `updated_at` string, date-time
  - `workspace_id` string, required
  - `connection_id` string, required
  - `webhook_id` string
  - `package_id` string
  - `parameters` AssessmentParameterInput[] — Filled-in answers to the package's parameter questions
    - `parameter_id` string
    - `name` string
    - `inputs` string[]
  - `target_url` string
  - `status` 'OPEN' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' | 'REJECTED'
  - `reference` string
  - `application_id` string
  - `job_id` string
  - `company_id` string
  - `candidate_id` string
  - `employee_id` string
  - `profile_name` string
  - `profile_first_name` string
  - `profile_last_name` string
  - `profile_resume_url` string
  - `profile_ip_address` string
  - `profile_date_of_birth` string
  - `profile_addresses` AssessmentAddress[]
    - `address1` string
    - `address2` string
    - `city` string
    - `region` string
    - `region_code` string
    - `postal_code` string
    - `country` string
    - `country_code` string
  - `profile_gender` 'MALE' | 'FEMALE' | 'INTERSEX' | 'TRANS' | 'NON_BINARY'
  - `profile_emails` string[]
  - `profile_telephones` string[]
  - `profile_national_identifier` string
  - `profile_social_media_urls` string[]
  - `response_completed_at` string, date-time
  - `response_expires_at` string, date-time
  - `response_issued_at` string, date-time
  - `response_status` 'OPEN' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' | 'REJECTED'
  - `response_score` number
  - `response_max_score` number
  - `response_url` string
  - `response_redirect_url` string
  - `response_download_urls` string[] — Report download URLs
  - `response_details` AssessmentResponseDetail[]
    - `title` string
    - `text` string
    - `is_private` boolean
    - `is_failed_reason` boolean
    - `parameter_id` string
    - `download_url` string
  - `response_source` string
  - `response_attributes` AssessmentAttribute[] — Additional result attributes
    - `type` 'TEXT' | 'NUMBER' | 'SUB_RESULT', required
    - `label` string, required
    - `value` string
    - `reference` string
    - `score_value` number
    - `score_max` number
    - `status` 'OPEN' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' | 'REJECTED'
  - `raw` object

## Response `200`

Successful

- AssessmentOrder
  - `id` string
  - `created_at` string, date-time
  - `updated_at` string, date-time
  - `workspace_id` string, required
  - `connection_id` string, required
  - `webhook_id` string
  - `package_id` string
  - `parameters` AssessmentParameterInput[] — Filled-in answers to the package's parameter questions
    - `parameter_id` string
    - `name` string
    - `inputs` string[]
  - `target_url` string
  - `status` 'OPEN' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' | 'REJECTED'
  - `reference` string
  - `application_id` string
  - `job_id` string
  - `company_id` string
  - `candidate_id` string
  - `employee_id` string
  - `profile_name` string
  - `profile_first_name` string
  - `profile_last_name` string
  - `profile_resume_url` string
  - `profile_ip_address` string
  - `profile_date_of_birth` string
  - `profile_addresses` AssessmentAddress[]
    - `address1` string
    - `address2` string
    - `city` string
    - `region` string
    - `region_code` string
    - `postal_code` string
    - `country` string
    - `country_code` string
  - `profile_gender` 'MALE' | 'FEMALE' | 'INTERSEX' | 'TRANS' | 'NON_BINARY'
  - `profile_emails` string[]
  - `profile_telephones` string[]
  - `profile_national_identifier` string
  - `profile_social_media_urls` string[]
  - `response_completed_at` string, date-time
  - `response_expires_at` string, date-time
  - `response_issued_at` string, date-time
  - `response_status` 'OPEN' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' | 'REJECTED'
  - `response_score` number
  - `response_max_score` number
  - `response_url` string
  - `response_redirect_url` string
  - `response_download_urls` string[] — Report download URLs
  - `response_details` AssessmentResponseDetail[]
    - `title` string
    - `text` string
    - `is_private` boolean
    - `is_failed_reason` boolean
    - `parameter_id` string
    - `download_url` string
  - `response_source` string
  - `response_attributes` AssessmentAttribute[] — Additional result attributes
    - `type` 'TEXT' | 'NUMBER' | 'SUB_RESULT', required
    - `label` string, required
    - `value` string
    - `reference` string
    - `score_value` number
    - `score_max` number
    - `status` 'OPEN' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' | 'REJECTED'
  - `raw` object

---

[API](https://skmtc.net/unified/apis/unified-to-api.md) · [All operations](https://skmtc.net/unified/apis/unified-to-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/unified/unified-to-api/versions/1f72720916e4/schema)