---
title: "Create an order"
method: POST
path: "/assessment/{connection_id}/order"
tags: ["assessment", "order"]
---

# Create an order

`POST /assessment/{connection_id}/order`

## Request

- Base URL: `http://api.unified.to`
- URL: `http://api.unified.to/assessment/{connection_id}/order`
- Auth: API key in header `authorization`

## Path parameters

- `connection_id` string, required

## Query parameters

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

## Request body

- AssessmentOrder
  - `id` string
  - `created_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `updated_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `workspace_id` string, required: Workspace ID that this order belongs to (reference to KmsSpace)
  - `connection_id` string, required: Connection ID that this order belongs to
  - `webhook_id` string: Webhook ID that this order belongs to
  - `package_id` string: Assessment package ID
  - `parameters` AssessmentParameterInput[]: Filled-in answers to the package's parameter questions
    - `parameter_id` string
    - `name` string: Name of parameter
    - `inputs` string[]
  - `target_url` string: URL to redirect user to after assessment
  - `status` 'OPEN' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' | 'REJECTED'
  - `reference` string: ATS-specific reference ID
  - `application_id` string: ATS application ID
  - `job_id` string: ATS job ID
  - `company_id` string: ATS company ID (reference to AtsCompany)
  - `candidate_id` string: ATS candidate ID
  - `employee_id` string: ATS employee ID
  - `profile_name` string
  - `profile_first_name` string
  - `profile_last_name` string
  - `profile_resume_url` string
  - `profile_ip_address` string: XXX.XXX.XXX.XXX
  - `profile_date_of_birth` string: YYYY-MM-DD
  - `profile_addresses` AssessmentAddress[]
    - `address1` string
    - `address2` string
    - `city` string
    - `region` string: Regional area (e.g., state in the U.S., province in Canada)
    - `region_code` string: Short form for regional area (e.g., two-letter stateprovince abbreviation)
    - `postal_code` string
    - `country` string
    - `country_code` string: Country code in ISO 3166 A-2 format
  - `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: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `response_expires_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `response_issued_at` string, date-time: Datetime that assessment was issued (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `response_status` 'OPEN' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' | 'REJECTED'
  - `response_score` number: Assessment score (e.g., 0-100)
  - `response_max_score` number: Maximum possible score
  - `response_url` string: URL to view detailed results
  - `response_redirect_url` string: URL to redirect the user to complete assessment
  - `response_download_urls` string[]: Report download URLs
  - `response_details` AssessmentResponseDetail[]
    - `title` string
    - `text` string
    - `is_private` boolean
    - `is_failed_reason` boolean
    - `parameter_id` string: In reference to the parameter input
    - `download_url` string
  - `response_source` string
  - `response_attributes` AssessmentAttribute[]: Additional result attributes
    - `type` 'TEXT' | 'NUMBER' | 'SUB_RESULT', required
    - `label` string, required
    - `value` string: For TEXT and NUMBER types
    - `reference` string: For SUB_RESULT type
    - `score_value` number
    - `score_max` number
    - `status` 'OPEN' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' | 'REJECTED': For SUB_RESULT type
  - `metadata` AssessmentMetadata[]
    - `id` string
    - `slug` string
    - `value` unknown
    - `namespace` string
    - `format` 'TEXT' | 'NUMBER' | 'DATE' | 'BOOLEAN' | 'FILE' | 'TEXTAREA' | 'SINGLE_SELECT' | 'MULTIPLE_SELECT' | 'MEASUREMENT' | 'PRICE' | 'YES_NO' | 'CURRENCY' | 'URL'
    - `extra_data` unknown
  - `raw` unknown

## Response `200`

Successful

- AssessmentOrder
  - `id` string
  - `created_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `updated_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `workspace_id` string, required: Workspace ID that this order belongs to (reference to KmsSpace)
  - `connection_id` string, required: Connection ID that this order belongs to
  - `webhook_id` string: Webhook ID that this order belongs to
  - `package_id` string: Assessment package ID
  - `parameters` AssessmentParameterInput[]: Filled-in answers to the package's parameter questions
    - `parameter_id` string
    - `name` string: Name of parameter
    - `inputs` string[]
  - `target_url` string: URL to redirect user to after assessment
  - `status` 'OPEN' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' | 'REJECTED'
  - `reference` string: ATS-specific reference ID
  - `application_id` string: ATS application ID
  - `job_id` string: ATS job ID
  - `company_id` string: ATS company ID (reference to AtsCompany)
  - `candidate_id` string: ATS candidate ID
  - `employee_id` string: ATS employee ID
  - `profile_name` string
  - `profile_first_name` string
  - `profile_last_name` string
  - `profile_resume_url` string
  - `profile_ip_address` string: XXX.XXX.XXX.XXX
  - `profile_date_of_birth` string: YYYY-MM-DD
  - `profile_addresses` AssessmentAddress[]
    - `address1` string
    - `address2` string
    - `city` string
    - `region` string: Regional area (e.g., state in the U.S., province in Canada)
    - `region_code` string: Short form for regional area (e.g., two-letter stateprovince abbreviation)
    - `postal_code` string
    - `country` string
    - `country_code` string: Country code in ISO 3166 A-2 format
  - `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: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `response_expires_at` string, date-time: (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `response_issued_at` string, date-time: Datetime that assessment was issued (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
  - `response_status` 'OPEN' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' | 'REJECTED'
  - `response_score` number: Assessment score (e.g., 0-100)
  - `response_max_score` number: Maximum possible score
  - `response_url` string: URL to view detailed results
  - `response_redirect_url` string: URL to redirect the user to complete assessment
  - `response_download_urls` string[]: Report download URLs
  - `response_details` AssessmentResponseDetail[]
    - `title` string
    - `text` string
    - `is_private` boolean
    - `is_failed_reason` boolean
    - `parameter_id` string: In reference to the parameter input
    - `download_url` string
  - `response_source` string
  - `response_attributes` AssessmentAttribute[]: Additional result attributes
    - `type` 'TEXT' | 'NUMBER' | 'SUB_RESULT', required
    - `label` string, required
    - `value` string: For TEXT and NUMBER types
    - `reference` string: For SUB_RESULT type
    - `score_value` number
    - `score_max` number
    - `status` 'OPEN' | 'IN_PROGRESS' | 'COMPLETED' | 'FAILED' | 'REJECTED': For SUB_RESULT type
  - `metadata` AssessmentMetadata[]
    - `id` string
    - `slug` string
    - `value` unknown
    - `namespace` string
    - `format` 'TEXT' | 'NUMBER' | 'DATE' | 'BOOLEAN' | 'FILE' | 'TEXTAREA' | 'SINGLE_SELECT' | 'MULTIPLE_SELECT' | 'MEASUREMENT' | 'PRICE' | 'YES_NO' | 'CURRENCY' | 'URL'
    - `extra_data` unknown
  - `raw` unknown

---

[API](https://skmtc.dev/unified/apis/unified-to-api-2.md) · [All operations](https://skmtc.dev/unified/apis/unified-to-api-2/llms.txt) · [OpenAPI document](https://skmtc.dev/unified/apis/unified-to-api-2/revisions/7a38bdd7f089?raw)