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

# Update an assessment package

`PUT /assessment/{connection_id}/package/{id}`

## Request

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

## Path parameters

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

## Request body

- AssessmentPackage: Used by assessment providers to SUBMIT packages to ATS systems
  - `id` string: Unique identifier for the assessment package
  - `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: Workspace ID that this package belongs to (reference to KmsSpace)
  - `connection_id` string: Connection ID that this package belongs to
  - `integration_types` string[]: Integration types that support this package
  - `name` string: Name of the assessment package
  - `type` 'SKILLS_TEST' | 'BEHAVIORAL_ASSESSMENT' | 'VIDEO_INTERVIEW' | 'BACKGROUND_CHECK' | 'REFERENCE_CHECK' | 'OTHER', required
  - `aliases` string[]: Alternative namesidentifiers for this package
  - `tags` string[]: Category tags (e.g., "Assessment", "Background Check")
  - `description` string: Detailed description
  - `parameters` AssessmentParameter[]: Questionsinputs needed for this assessment (aligned with verification)
    - `id` string
    - `name` string
    - `public_question` string: Question to ask the candidateuser
    - `type` 'TEXT' | 'NUMBER' | 'MULTIPLE_CHOICE' | 'MULTIPLE_SELECT' | 'DATE' | 'FILE'
    - `options` string[]: Options for MULTIPLE_CHOICE and MULTIPLE_SELECT
    - `file_types` string[]: Valid file MIME types for FILE type
    - `valid_regions` string[]: Regions where this parameter is valid ({country}-{state} or {country})
    - `is_required` boolean
  - `has_redirect_url` boolean: Whether provider redirects user to complete assessment
  - `has_target_url` boolean: Where provider redirects user after completion
  - `needs_ip_address` boolean: Whether IP address is required
  - `max_score` number: Maximum possible score if this assessment returns a score
  - `info_url` string: URL to find additional information about this package
  - `regions` AssessmentPackageRegion[]
    - `regions` string[]: Countryregion codes where this package is available ({country}-{state} or {country})
    - `cost_amount` number
    - `currency` string: ISO 4217 format
    - `processing_time` number: Processing time in milliseconds
  - `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

- AssessmentPackage: Used by assessment providers to SUBMIT packages to ATS systems
  - `id` string: Unique identifier for the assessment package
  - `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: Workspace ID that this package belongs to (reference to KmsSpace)
  - `connection_id` string: Connection ID that this package belongs to
  - `integration_types` string[]: Integration types that support this package
  - `name` string: Name of the assessment package
  - `type` 'SKILLS_TEST' | 'BEHAVIORAL_ASSESSMENT' | 'VIDEO_INTERVIEW' | 'BACKGROUND_CHECK' | 'REFERENCE_CHECK' | 'OTHER', required
  - `aliases` string[]: Alternative namesidentifiers for this package
  - `tags` string[]: Category tags (e.g., "Assessment", "Background Check")
  - `description` string: Detailed description
  - `parameters` AssessmentParameter[]: Questionsinputs needed for this assessment (aligned with verification)
    - `id` string
    - `name` string
    - `public_question` string: Question to ask the candidateuser
    - `type` 'TEXT' | 'NUMBER' | 'MULTIPLE_CHOICE' | 'MULTIPLE_SELECT' | 'DATE' | 'FILE'
    - `options` string[]: Options for MULTIPLE_CHOICE and MULTIPLE_SELECT
    - `file_types` string[]: Valid file MIME types for FILE type
    - `valid_regions` string[]: Regions where this parameter is valid ({country}-{state} or {country})
    - `is_required` boolean
  - `has_redirect_url` boolean: Whether provider redirects user to complete assessment
  - `has_target_url` boolean: Where provider redirects user after completion
  - `needs_ip_address` boolean: Whether IP address is required
  - `max_score` number: Maximum possible score if this assessment returns a score
  - `info_url` string: URL to find additional information about this package
  - `regions` AssessmentPackageRegion[]
    - `regions` string[]: Countryregion codes where this package is available ({country}-{state} or {country})
    - `cost_amount` number
    - `currency` string: ISO 4217 format
    - `processing_time` number: Processing time in milliseconds
  - `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)