HYhypertrack
Workers

Create Worker

Create a worker

post/workers/

Request

Request body

profileobject nullable

Additional customer provided data associated with a worker

namestring nullable

Name of the worker

product_typesstring[] nullable

List of product types used for worker matching during order planning

unavailable_onstring[] nullable

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

worker_handlestring required

Unique customer provided identifier for a worker

device_idstring uuid nullable

Unique ID representing the worker's device

ops_group_handlestring nullable

Unique identifier for an Ops Group to which the worker belongs

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.