Update Ops Group

patch

https://v3.api.hypertrack.com/workers/ops-groups/{ops_group_handle}

Update Ops Group by ops_group_handle

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

ops_group_handle

string

required

Body Params

ops_group_label

string | null

Defaults to null

Display name for an Ops Group

route_start_location

string | null

enum

Defaults to null

Configuration to identify where routes are expected to start

Allowed:

route_completion_type

string | null

enum

Defaults to null

Configuration to identify where routes are expected to end

Allowed:

objective_fn

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

default_shift_start_time

string | null

Defaults to null

Default time HH:mm when the shift starts for drivers

default_shift_end_time

string | null

Defaults to null

Default time HH:mm when the shift ends for drivers

route_capacity

integer | null

Defaults to null

Maximum number of orders in a route

route_max_distance

integer | null

Defaults to null

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

timezone

string | null

Defaults to null

IANA timezone of the Ops Group

shift_availability_mode

string | null

enum

Defaults to null

deprecated

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

Allowed:

order_tracking_mode

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

operations_radius

integer | null

Defaults to null

Maximum distance in meters from the ops group home within which order destinations are allowed

enforce_operations_radius

boolean | null

Defaults to null

Whether to enforce operations_radius validation at order creation time

Responses

200Successful response

401Authentication error

404Not found

422Validation error