Update Ops Group

Update Ops Group by ops_group_handle

Authorization

AuthorizationBasic <token>

In: header

Path Parameters

ops_group_handle*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

ops_group_label?|

Display name for an Ops Group

route_start_location?|

Configuration to identify where routes are expected to start

route_completion_type?|

Configuration to identify where routes are expected to end

objective_fn?|

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

ops_group_home?

Location of the Ops Group

default_shift_start_time?|

Default time HH:mm when the shift starts for drivers

default_shift_end_time?|

Default time HH:mm when the shift ends for drivers

route_capacity?|

Maximum number of orders in a route

route_max_distance?|

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

timezone?|

IANA timezone of the Ops Group

shift_availability_mode?|

Deprecated

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

order_tracking_mode?|

Deprecated

Order tracking mode associated with the ops-group

order_tracking_automation?

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

work_status_automation?array<>|

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

schedule?array<|>|

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

app_config?|

Configuration specific to order's app

operations_radius?|

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

enforce_operations_radius?|

Whether to enforce operations_radius validation at order creation time

Response Body

`application/json`

curl -X PATCH "https://example.com/workers/ops-groups/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "ops_group_handle": "san-jose-store",  "ops_group_label": "store",  "timezone": "America/Los_Angeles",  "route_start_location": "ops_group_home",  "route_completion_type": "manual",  "ops_group_home": {    "geometry": {      "type": "Point",      "coordinates": [        -121.93186,        36.3570534      ]    },    "address": "1709 Automation Pkwy, San Jose, CA 95101"  },  "objective_fn": "minimise_time",  "route_capacity": 10,  "route_max_distance": 20000,  "default_shift_start_time": "07:00",  "default_shift_end_time": "19:00",  "order_tracking_mode": "manual",  "shift_availability_mode": "manual",  "order_tracking_automation": {    "type": "manual"  }}

{  "detail": {},  "message": "string"}

{  "detail": {},  "message": "string"}

{  "detail": {    "<location>": {      "<field_name>": [        "string"      ]    }  },  "message": "string"}

Authorization

Path Parameters

Request Body

Response Body

200application/json

401application/json

404application/json

422application/json

`application/json`

`application/json`

`application/json`

`application/json`