HYhypertrack
Workers

Patch Worker

Update worker information using the worker_handle

patch/workers/{worker_handle}

Request

Path parameters

worker_handlestring required

Request body

device_idstring uuid nullable

Unique ID representing the worker's device

namestring nullable

Name of the worker

ops_group_handlestring nullable

Unique identifier for an Ops Group to which the worker belongs

product_typesstring[] nullable

List of product types used for worker matching during order planning

profileobject nullable

Additional customer provided data associated with a worker

unavailable_onstring[] nullable

List of dates (YYYY-MM-DD) on which the worker is unavailable

transfer_existing_workboolean nullable

Flag to indicate whether existing work of the worker is to be transferred to the newly linked device.Only applicable at the time of linking worker with a device.

Response

Successful response

worker_handlestring required

Unique customer provided identifier for a worker

namestring nullable

Name of the worker

ops_group_handlestring required

Unique identifier for an Ops Group to which the worker belongs

product_typesstring[] nullable

List of product types used for worker matching during order planning

device_idstring nullable

Unique ID representing the worker's device

profileobject nullable

Metadata associated with a worker

deletedboolean nullable

Flag indicating whether the worker was deleted

created_atstring required

Timestamp at which the worker was created

deleted_atstring nullable

Timestamp at which the worker was deleted

unavailable_onstring[] nullable

List of dates (YYYY-MM-DD) on which the worker is not available

timezonestring nullable

Timezone of the worker

Changes

No recorded changes to this operation across all 1 revision of this API.