Update Business Unit

put

https://dc1demogwext.paylocity.com/compliance/v1/companies/{companyId}/businessUnits/{businessUnitId}

🚧
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

Path Params

companyId

string

required

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

businessUnitId

string

required

Business Unit ID associated with the business unit. Required.

Body Params

Business unit request.

Update package businessUnit request payload.
For PUT operations, all fields are required to replace the entire entity.

businessUnitName

string

required

length ≥ 1

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

isActive

boolean

required

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

description

string | null

Optional description for the package businessUnit.

Headers

testMode

boolean

If true all responses are mocked and generated randomly.

Responses

204

Returns confirmation that business unit has been updated

401

Unauthorized

Language

Credentials

Header

Loading…

Response

Choose an example:

application/json

400Bad Request Error - Returns the details of the error

404Not Found - Business unit has not been found

415Unsupported Media Type - Returns the details of the error