API Reference

Update Ops Group

patch
https://v3.api.hypertrack.com/workers/ops-groups/

Update Ops Group by ops_group_handle

Path Params
string
required
Body Params
string | null
Defaults to null

Display name for an Ops Group

string | null
enum
Defaults to null

Configuration to identify where routes are expected to start

Allowed:
string | null
enum
Defaults to null

Configuration to identify where routes are expected to end

Allowed:
string | null
enum
Defaults to null

Configuration to identify the metric used by the solver when generating optimized routes

Allowed:
ops_group_home
object | null

Location of the Ops Group

string | null
Defaults to null

Default time HH:mm when the shift starts for drivers

string | null
Defaults to null

Default time HH:mm when the shift ends for drivers

integer | null
Defaults to null

Maximum number of orders in a route

integer | null
Defaults to null

Maximum distance in meters used by the resolver to constrain each route distance

string | null
Defaults to null

IANA timezone of the Ops Group

string | null
enum
Defaults to null
deprecated

Flag to start/stop availability of all drivers based on the ops group shift

Allowed:
string | null
Defaults to null
deprecated

Order tracking mode associated with the ops-group

order_tracking_automation
object | null

A configuration object to enable/disable and customize automatic order tracking.

work_status_automation
array of objects | null
Defaults to null

List of configuration object to enable/disable and customize automatic work status updation. If null, the default behavior is equivalent to: {"type": "manual"}.

work_status_automation
schedule
array | null
Defaults to null

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

schedule
app_config
object | null

Configuration specific to order's app

Responses

Updated 7 months ago

Language
Credentials
:
Response 
Click Try It! to start a request and see the response here! Or choose an example:
application/json
Updated 7 months ago