Workers

Set Worker Work Status

Set the work status of a worker identified by the worker_handle

post/workers/{worker_handle}/work_status

Request

Base URL
https://v3.api.hypertrack.com
Auth
- HTTP basic
- or HTTP bearer
TypeScript
https://skmtc.dev/hypertrack/apis/hypertrack-api/docs/workers/:worker_handle/work_status/post.ts
A function with typed inputs. Its response is checked against the schema.

worker_handlestring required

trackingboolean nullable

Flag set to indicate that the worker is being tracked while working

availableboolean nullable

Flag set to indicate that the worker is available for work

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

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