Upsert Assessment Package

🚧

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 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 Params
string
required

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

string
required

Package ID.

Body Params

Package to put.

Assessment package payload.

string | null

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

status
object

Package status payload.

string | null

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

string | null

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

assessments
array of objects | null

An array of objects representing the assessments included in the package. Required.

assessments
Headers
boolean

If true all responses are mocked and generated randomly.

string
required

Authorization token. Ex. Bearer ...

string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Responses

204

No Content - Resource has been updated.

Language
LoadingLoading…
Response
Choose an example:
application/json