Create Business Units

🚧

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 endpoint inserts businessUnits and their associated status by company ID for a given client

Use Cases

  • Partner wants to send over one or multiple businessUnits for a client. This can either be when onboarding a new client, or when client wants to add new businessUnits to their company

This endpoint only creates new business units. To change the status of an existing business unit, use the Update Business Unit endpoint (PUT).

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 Business Unit data.

Package Organization request payload.

businessUnits
array of objects | null

Array of new business units to create. Business units whose ID or name already exists for the company are rejected with 400 Bad Request;
to change the status of an existing business unit, use the Update Business Unit endpoint (PUT).

businessUnits
Headers
boolean

If true all responses are mocked and generated randomly.

Responses
201

Returns details of the create operation

401

Unauthorized

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