Patch Worker

patch

https://v3.api.hypertrack.com/workers/{worker_handle}

Update worker information using the worker_handle

Path Params

worker_handle

string

required

Body Params

device_id

uuid | null

Defaults to null

Unique ID representing the worker's device

name

string | null

Defaults to null

Name of the worker

ops_group_handle

string | null

Defaults to null

Unique identifier for an Ops Group to which the worker belongs

home

object | null

Worker's home location

product_types

array of strings | null

Defaults to null

List of product types used for worker matching during order planning

product_types

schedule

array | null

Defaults to null

List of schedules used for worker matching during order planning and auto start/stop of availability or tracking of the worker

schedule

profile

object | null

Additional customer provided data associated with a worker

unavailable_on

array of strings | null

Defaults to null

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

unavailable_on

transfer_existing_work

boolean | null

Defaults to true

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.

Responses

Language

Credentials

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response

401Authentication error

404Not found

422Validation error