Update base shift

post

{backendUrlScheme}://{backendUrlHost}/api/public/base-shift/update

This endpoint can be used to update a base shift. In the request you provide a session ID in the header and base shift details in the body.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

baseShiftId

string

required

ID of the base shift to update

startDate

number

Base shift start date/time in milliseconds

duration

number

Base shift duration in milliseconds

shiftTemplateId

string

Shift template ID

shiftPlanningConfigId

string

Shift planning config ID

archived

boolean

Whether the base shift is archived

endType

string

Base shift recurrence end type

interval

number

Recurrence interval

weekStart

number

Week start day

timezone

string

Timezone used for recurrence handling

recurrencyRule

string

Recurrence rule

frequency

string | null

Recurrence frequency. If set to 'never', recurrence is unset by the controller.

endDate

number

Recurrence end date in milliseconds

count

number

Recurrence occurrence count

byWeekDay

array

Recurrence by weekday

byWeekDay

byMonth

array of numbers

Recurrence by month

byMonth

bySetPos

array of numbers

Recurrence by set position

bySetPos

byMonthDay

array of numbers

Recurrence by month day

byMonthDay

byWeekNumber

array of numbers

Recurrence by week number

byWeekNumber

dateExceptions

array | null

Date exceptions for this base shift

dateExceptions

Headers

bsy-sid

string

required

Session ID

Responses

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Base shift updated successfully

400Bad request, invalid base shift details

401Unauthorized access, invalid or missing session ID