(EA) Update Shift by Company

🚧

Early Access API Version

This endpoint version is currently in Early Access and available only to approved early adoption (EA) participants. Do not rely on this version for production workloads unless explicitly authorized. If you have any feedback, please share with your designated Early Adoption program representative.

Summary Description

The Update Shift by Company endpoint updates an existing shift at the company level. It allows organizations to modify scheduling details such as the duration, start times, pay type, and cost center after the shift has been created.

Use cases:

  • Planners can adjust shift times, responsibilities, or locations.
  • Automated systems can balance shifts across teams or departments.
  • Managers can modify shift requirements in line with updated staffing policies.
Path Params
string
required

The Paylocity Company ID. This is the unique value provided by Paylocity to each specific Payroll Entity.

string
required

The unique identifier of the shift.

Body Params

The shift update request payload.

The updated values for a shift.

assignedTo
object
breaks
array of objects | null

A list of breaks associated with the shift.

breaks
costCenters
array of strings | null

A list of identifiers for cost centers associated with the shift.

costCenters
int32

The length of the shift or break, in minutes.

boolean

Indicates whether the note was made by the employee.

boolean

Indicates whether the shift has been published.

string | null

The content of the note attached to the shift, if any.

int32 | null

Numeric key representing the position associated with the shift.

date-time

Relative DateTime of the beginning of the shift. Value must not have timezone information.

uuid

The unique identifier of the schedule the shift belongs to.

Headers
string
required
Defaults to Bearer JWT_GOES_HERE

Authorization token. Ex. Bearer ...

Responses
202

Accepted

204

No Content

401

Unauthorized

Language
LoadingLoading…
Response
Choose an example:
application/json