Skip to main content
PATCH
Update a shift template

Authorizations

Authorization
string
header
required

Issue keys in Settings → API. Send them as Authorization: Bearer ont_… (an X-Api-Key: ont_… header is also accepted). Session-cookie routes are used by the OnTime web apps and are shown for completeness.

Path Parameters

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Body

application/json
code
enum<string>
Available options:
G,
M,
E,
N,
F
category
enum<string>
default:G
Available options:
G,
M,
E,
N,
F,
FL
sku
string | null
name
string
type
enum<string>
default:fixed
Available options:
fixed,
flexible,
rotational,
field,
custom
status
enum<string>
default:draft
Available options:
draft,
published
tags
string[]
allLocations
boolean
default:true
locationIds
string<uuid>[]
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
effectiveFrom
string | null
startTime
string
endTime
string
workingHours
number
unpaidBreakMinutes
integer
Required range: -9007199254740991 <= x <= 9007199254740991
breakWindowStart
string | null
breakWindowEnd
string | null
gracePeriodMinutes
integer
Required range: -9007199254740991 <= x <= 9007199254740991
halfDayCutoffHours
number
weeklyOff
string[]
autoCheckoutAfter
string | null
otEligibleAfterMinutes
integer
Required range: -9007199254740991 <= x <= 9007199254740991
otCapPerDayMinutes
integer
Required range: -9007199254740991 <= x <= 9007199254740991
otMultiplierWeekday
number
default:1.5
Required range: x <= 10
otMultiplierHolidayOff
number
default:2
Required range: x <= 10
otApprovalThresholdMinutes
integer
default:120
Required range: -9007199254740991 <= x <= 9007199254740991
workingDays
object | null
punchSources
object | null
lateDeduction
object | null
notifications
object[]

Response

200 - application/json

Success

id
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
orgId
string<uuid>
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
code
enum<string>
required
Available options:
G,
M,
E,
N,
F
category
enum<string>
required
Available options:
G,
M,
E,
N,
F,
FL
sku
string | null
required
name
string
required
type
enum<string>
required
Available options:
fixed,
flexible,
rotational,
field,
custom
status
enum<string>
required
Available options:
draft,
published
tags
string[]
required
allLocations
boolean
required
locationIds
string<uuid>[]
required
Pattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$
effectiveFrom
string | null
required
startTime
string
required
endTime
string
required
workingHours
number
required
unpaidBreakMinutes
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
breakWindowStart
string | null
required
breakWindowEnd
string | null
required
gracePeriodMinutes
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
halfDayCutoffHours
number
required
weeklyOff
string[]
required
autoCheckoutAfter
string | null
required
otEligibleAfterMinutes
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
otCapPerDayMinutes
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
otMultiplierWeekday
number
required
Required range: x <= 10
otMultiplierHolidayOff
number
required
Required range: x <= 10
otApprovalThresholdMinutes
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
workingDays
object | null
required
punchSources
object | null
required
lateDeduction
object | null
required
notifications
object[]
required