PApaylocity
Package

Upsert Assessment Packages [Batch]

Changed on

🚧 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 if you would like to discuss partnership opportunities.

Summary Description

This API endpoint allows assessment partners to insert or update multiple assessment packages in a single request within Paylocity’s platform. Each package is a curated collection of assessment tests, such as a series of tests tailored for different job roles.

Use Cases

  • Partner sends the initial status of the package and tests, i.e. Ordered and Pending
  • Bulk Operations: Enables partners to manage multiple packages at once, streamlining the process of updating or adding new assessments
  • Deactivation and Removal: Packages can be deactivated or scheduled for removal by setting appropriate status values and endDate
  • Company-Specific Offerings: Partners can target specific Paylocity clients by using the companyId in the URL, allowing for customized assessment packages for each company
put/apiHub/performanceManagement/v1/companies/{companyId}/assessmentPackages

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
  • Auth
    none declared. Required headers: Authorization

Path parameters

companyIdstring required

The Paylocity Company Identifier. This is the unique value provided by Paylocity to each specific Payroll Entity. Allowable Values: 9 char max.

Headers

testModeboolean

If true all responses are mocked and generated randomly.

Authorizationstring required

Authorization token. Ex. Bearer ...

Request body

idstring nullable

The unique ID of the package. Required. Max length = 150.

summarystring nullable

A summary of the package. Required. Max length = 250.

namestring nullable

The name of the package. Required. Max length = 250.

Response

Created - Resources have been created.

idstring nullable

The unique ID of the package. Required. Max length = 150.

summarystring nullable

A summary of the package. Required. Max length = 250.

namestring nullable

The name of the package. Required. Max length = 250.

Changes