Update a worker
Workers
Update a worker
Update a worker’s number, original start date, entity, or workspace attributes.
PATCH
Update a worker
string
required
The ID of a worker in your workspace.
number, starts, and entity; other
native worker facts continue to use their existing domain operations.
string | null
Company-assigned worker number.
string | null
The worker’s original start date in
YYYY-MM-DD format.string | null
Identifier of the entity in this workspace to assign to the worker. Entity
changes retain the existing payroll-provider assignment behavior.
YYYY-MM-DD), and select fields are supported. Select values use option
keys, such as medium, rather than labels. Send null to clear a workspace
attribute. Renaming a field key preserves its stored values; integrations must
use the new key after the rename.
For example, if your workspace defines a select field with key tshirt_size:
invalid error and field-specific details. Worker
access and write permissions apply to workspace attributes too.
Workspace attributes are optional. A Worker object supports up to 100 active
workspace attributes, a select field supports up to 100 options, and a string
value supports up to 1,024 characters.