PApaylocity
Business Unit

Update Business Unit

🚧 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

This is used to update an already registered businessUnit's details by companyId and specific businessUnitId for a given client

Use Cases

  • Partner wants to update the details of a specific businessUnit for a client
put/compliance/v1/companies/{companyId}/businessUnits/{businessUnitId}

Request

  • Base URL
    dc1demogwext.paylocity.com (relative, and the document’s source URL is not known)
  • URL
    dc1demogwext.paylocity.com/compliance/v1/companies/{companyId}/businessUnits/{businessUnitId}
  • Auth
    API key in header 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

businessUnitIdstring required

Business Unit ID associated with the business unit. Required.

Headers

testModeboolean

If true all responses are mocked and generated randomly.

Authorizationstring required

Authorization token. Ex. Bearer ...

Request body

businessUnitNamestring required

Organization name for the package businessUnit. Allowable Values: 250 char max

isActiveboolean required

A Boolean value indicating if the businessUnit is active. Allowable Values: true, false

descriptionstring nullable

Optional description for the package businessUnit.

Response

Returns confirmation that business unit has been updated

Changes

No recorded changes to this operation across all 1 revision of this API.