Update Configuration

patch

https://{companyDomain}.bamboohr.com/api/v1/time-tracking/configurations/{id}

Updates a time tracking configuration using JSON Merge Patch (RFC 7396) semantics: only the properties present in the body are applied, omitted properties are unchanged, and an explicit null clears a nullable property. Both GLOBAL and GROUP configurations can be updated. Content-Type: application/merge-patch+json is preferred because it names those semantics, but application/json is also accepted.

OAuth Scopes: time_tracking:configurations.write

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

integer

required

The time tracking configuration ID.

Body Params

JSON Merge Patch body for updating a time tracking configuration. Only the properties present are applied; an explicit null clears a nullable property. The read-only type and employeeIds properties are rejected.

name

string

length between 1 and 255

The configuration name. Unique per company.

timesheetType

string

enum

How time is logged.

Allowed:

workWeekStartsOn

string

enum

Day of week the work week starts.

Allowed:

approverType

string

enum

Who approves timesheets. Moving away from SPECIFIC_PERSON clears approverUserId server-side.

Allowed:

approverUserId

The user ID of the approver. Required in the same body when setting approverType to SPECIFIC_PERSON; not allowed unless the approver is a specific person.

approvalCutoff

string

Time of day by which timesheets must be approved, in 24-hour HH:MM format.

approvalCutoffDays

integer

0 to 5

Number of days before the pay date the cutoff applies.

clockInSchedulePolicy

string

enum

When scheduled employees can clock in.

Allowed:

restrictWebClockActions

boolean

When true, removes the time clock from bamboohr.com for employees in this configuration.

mobileEnabled

boolean

When true, employees can log time using the BambooHR mobile app.

geolocationEnabled

boolean

When true, employee location is required when clocking in/out via mobile. Stored but has no effect while mobileEnabled is false.

customOvertimeEnabled

boolean

When true, the overtime threshold fields are honored. Setting it to false clears all three thresholds server-side.

overtimeDailyHours

Daily overtime threshold in hours. Only allowed while customOvertimeEnabled is true. Decimal string with at most 2 decimals, at least 1 and less than 24.

overtimeDailyDoubleHours

Daily double-overtime threshold in hours. Only allowed while customOvertimeEnabled is true. Decimal string with at most 2 decimals, at least 1 and less than 24.

overtimeWeeklyHours

Weekly overtime threshold in hours. Only allowed while customOvertimeEnabled is true. Decimal string with at most 2 decimals, at least 1 and less than 169.

Headers

content-type

string

enum

Defaults to application/merge-patch+json

Generated from available request content types

Allowed:

Responses

Language

Credentials

URL

Loading…

Response

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

application/json

200The updated configuration.

400Malformed request body.

401Unauthorized. Missing or invalid authentication.

403Forbidden. Insufficient permissions.

404Configuration not found, or soft-deleted.

409Conflict. Another configuration already uses the new name.

422Validation error (e.g., an invalid field value, patching the read-only type or employeeIds, missing approverUserId when setting approverType to SPECIFIC_PERSON, or an overtime threshold set while customOvertimeEnabled is false).