--- title: "Upsert Assessment Package" method: PUT path: "/apiHub/performanceManagement/v1/companies/{companyId}/assessmentPackages/{packageId}" tags: ["Package"] --- # Upsert Assessment Package `PUT /apiHub/performanceManagement/v1/companies/{companyId}/assessmentPackages/{packageId}` ## Request - Base URL: `dc1demogwext.paylocity.com` (relative, and the document’s source URL is not known) - URL: `dc1demogwext.paylocity.com/apiHub/performanceManagement/v1/companies/{companyId}/assessmentPackages/{packageId}` - Auth: none declared. Required headers: `Authorization` > 🚧 Partner Restricted > All assessment API endpoints are restricted to assessment providers that have signed a Paylocity technology partnership agreement. [Please reach out to our team](https://www.paylocity.com/contact/partner-form/) if you would like to discuss partnership opportunities. **Summary Description** This API endpoint is designed for assessment partners to manage their assessment packages within Paylocity’s platform by using the companyID and the packageID. In this API product, a package is a collection of related assessments, such as a “Skills Battery”, which includes all relevant tests for a job’s skills assessment. There could be multiple tests within a package. A job could also have multiple assessment packages, if needed. **Use Cases** - Insert or Update: Allows partners to insert new packages or update existing ones. This could involve removing or adding tests into a package - Deactivate or Remove: Partners can deactivate a package by setting the status flag or schedule its removal by specifying an endDate - Granular Control: By specifying a companyId, partners can target specific Paylocity clients, ensuring tailored assessment offerings - Global offering: by using companyId B6001 Partner’s can assign specific assessments for all clients that use your platform ## Path parameters - `companyId` string, required - `packageId` string, required ## Headers - `testMode` boolean - `Authorization` string, required ## Request body - PackageDto: Assessment package payload. - `id` string, nullable: The unique ID of the package. Required. Max length = 150. - `status` StatusDto: Package status payload. - `startDate` string, date-time: Start date of package validity. For immediate start use DateTime.UtcNow. Required. - `endDate` string, date-time, nullable: End date of package validity. If package doesn’t have expiration date, this field should be null. Optional. - `value` 'Active' | 'Inactive' | 'Deleted' | 'Unknown', nullable: Status value. Possible values: “Active, Inactive, Deleted, Unknown”. If value is not provided it will be calculated based on start/end date. Optional. - `summary` string, nullable: A summary of the package. Required. Max length = 250. - `name` string, nullable: The name of the package. Required. Max length = 250. - `assessments` AssessmentDto[], nullable: An array of objects representing the assessments included in the package. Required. - `id` string, nullable: The unique ID of the assessment. Required. Max length = 150. - `name` string, nullable: The name of the assessment. Required. Max length = 250. - `summary` string, nullable: A summary of the assessment. Required. Max length = 250. - `tests` AssessmentTestDto[], nullable: An array of objects representing the tests included in the assessment. Required. - `id` string, nullable: ID of the test. Required. Max length = 150. - `name` string, nullable: Name of the test. Required. Max length = 250. - `category` string, nullable: Category of the test. Required. Max length = 50. - `description` string, nullable: Description of the test. Required. Max length = 250. ## Response `201` Created - Resource has been created. - PackageDto: Assessment package payload. - `id` string, nullable: The unique ID of the package. Required. Max length = 150. - `status` StatusDto: Package status payload. - `startDate` string, date-time: Start date of package validity. For immediate start use DateTime.UtcNow. Required. - `endDate` string, date-time, nullable: End date of package validity. If package doesn’t have expiration date, this field should be null. Optional. - `value` 'Active' | 'Inactive' | 'Deleted' | 'Unknown', nullable: Status value. Possible values: “Active, Inactive, Deleted, Unknown”. If value is not provided it will be calculated based on start/end date. Optional. - `summary` string, nullable: A summary of the package. Required. Max length = 250. - `name` string, nullable: The name of the package. Required. Max length = 250. - `assessments` AssessmentDto[], nullable: An array of objects representing the assessments included in the package. Required. - `id` string, nullable: The unique ID of the assessment. Required. Max length = 150. - `name` string, nullable: The name of the assessment. Required. Max length = 250. - `summary` string, nullable: A summary of the assessment. Required. Max length = 250. - `tests` AssessmentTestDto[], nullable: An array of objects representing the tests included in the assessment. Required. - `id` string, nullable: ID of the test. Required. Max length = 150. - `name` string, nullable: Name of the test. Required. Max length = 250. - `category` string, nullable: Category of the test. Required. Max length = 50. - `description` string, nullable: Description of the test. Required. Max length = 250. ## Other responses - `204`: No Content - Resource has been updated. - `400`: Bad Request - Returns the details of the error. - `401`: Unauthorized - `415`: Unsupported Media Type - Returns the details of the error. ## Changes - **2026-11-03** `bf323b2134ff`: 1 info - endpoint added [Operation history](https://skmtc.dev/paylocity/apis/assessments-api/changes/apiHub/performanceManagement/v1/companies/:companyId/assessmentPackages/:packageId/put.md) --- [API](https://skmtc.dev/paylocity/apis/assessments-api.md) - [All operations](https://skmtc.dev/paylocity/apis/assessments-api/llms.txt) - [OpenAPI document](https://skmtc.dev/paylocity/apis/assessments-api/revisions/bf323b2134ff?raw)