BAbamboohr
Time Tracking
Public API

Update Time Tracking Time Clock

Changed on

Updates a time tracking time clock using JSON Merge Patch (RFC 7396) semantics: only the properties present in the body are applied. Only name and timezone are mutable, and at least one of them must be provided. Both changes are written through to the GT Clocks partner; writes are never served from cache, so a write returns 503 with a Retry-After header when the partner is unreachable. A successful write invalidates the cached device list so the next read reflects the change. Content-Type: application/merge-patch+json is preferred because it names those semantics, but application/json is also accepted.

OAuth Scopes: time_tracking:time_clocks.write

patch/api/v1/time-tracking/time-clocks/{id}

Request

Path parameters

idstring uuid required

The time tracking time clock ID.

Request body

namestring

The name of the time clock.

timezonestring

IANA timezone name the device records clock entries in.

Example request

{
  "name": "Warehouse Entrance",
  "timezone": "America/Denver"
}

Response

The updated time clock.

idstring uuid

The unique identifier for the time clock.

namestring

The name of the time clock.

serialNumberstring

The manufacturer serial number of the device.

type'TIME_CLOCK' | 'TIME_CLOCK_PLUS'

The hardware model of the time clock.

onlineboolean nullable

Whether the device is reachable. Null when device status is temporarily unavailable.

configOnlineboolean nullable

Whether the device is receiving configuration updates. Null when device status is temporarily unavailable.

dataOnlineboolean nullable

Whether the device is sending clock data. Null when device status is temporarily unavailable.

firmwareOnlineboolean nullable

Whether the device is receiving firmware updates. Null when device status is temporarily unavailable.

timezonestring

IANA timezone name the device records clock entries in.

Example response

{
  "id": "a3f1c2d4-5b6e-4f70-8a91-2c3d4e5f6a7b",
  "name": "Warehouse Entrance",
  "serialNumber": "GT4-0001234",
  "type": "TIME_CLOCK",
  "online": true,
  "configOnline": true,
  "dataOnline": true,
  "firmwareOnline": true,
  "timezone": "America/Denver"
}

Changes