Create Worker

post

https://v3.api.hypertrack.com/workers/

Create a worker

Body Params

profile

object | null

Additional customer provided data associated with a worker

name

string | null

Defaults to null

Name of the worker

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

unavailable_on

array of strings | null

Defaults to null

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

unavailable_on

worker_handle

string

required

Unique customer provided identifier for a worker

device_id

uuid | null

Defaults to null

Unique ID representing the worker's device

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

ops_group_handle

string | null

Defaults to default

Unique identifier for an Ops Group to which the worker belongs

Responses

Language

Credentials

Response

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

application/json

201Successful response

401Authentication error

422Validation error