Q2 2025 Roadmap: Request a beta API key and access upcoming features: Embedded Notifications, Team Communications and more.

Update schedule entry

PATCH

/api/organizations/{organization_id}/locations/{location_id}/schedules/{id}

Modifies an existing schedule entry.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '/api/organizations//locations//schedules/' \
--header 'Content-Type: application/json' \
--data-raw ''

Response Example

{}

Request

Path Params

string

required

location_id

string

required

organization_id

string

required

Body Params application/json

start

string

optional

The start date of the schedule

end

string

optional

The end date of the schedule

locationId

string

optional

The location id of the schedule

employeeId

string

optional

The employee id of the schedule

roleId

string

optional

The role id of the schedule

timezone

string

optional

The timezone of the schedule

utcOffset

number

optional

The utc offset of the schedule

colors

object

optional

The colors of the schedule

breaks

array[string]

optional

The breaks of the schedule

payrollId

string

optional

The payroll id of the schedule

Examples

Responses

🟢200OK

application/json

Body

object {0}

Bulk copy schedule shifts

Remove schedule entry