Upsert Screening Packages [Batch]

🚧

Partner Restricted

All background check API endpoints are restricted to background check 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

Bulk Upsert information about screening packages

Use Cases

  • Partner wants to send over multiple screening packages for a client, can be when onboarding a new client, or can be when client adds new packages to their company
  • Partner wants to make bulk changes to screening packages to make them either active or inactive for a client
  • Partner wants to update the prices of a client’s screening packages
  • Partner wants to bulk add services to a packages
  • Partner wants to add a billing code to correlate to a specific BGC package
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

Body Params

The Package information

Screening Package Upsert Request.

packages
array of objects | null

The list of screening packages to be upserted.

packages
Headers
boolean

If true all responses are mocked and generated randomly

Responses

400

Bad Request Error - Returns the details of the error

401

Unauthorized

415

Unsupported Media Type - Returns the details of the error

Language
Credentials
Header
LoadingLoading…
Response
Choose an example:
application/json