routes

Update Route

Changed on

Update a route's metadata (name, notes) and/or its stop order/locations.

If location_ids is provided in the request body:

  • The route's stops are fully replaced with the new ordered list.
  • The routing algorithm is re-run to compute the new polyline and mileage.
  • This will affect ALL route groups that share this route.

If only name/notes are provided, stops and mileage are left unchanged.

patch/api/routes/{route_id}

Request

  • The document declares no server URL.
  • Auth: HTTP bearer

Path parameters

route_idstring uuid required

Request body

driver_idstring uuid nullable
location_idsstring[] nullable
namestring nullable
notesstring nullable
start_timestring time nullable

Response

Successful Response

cloned_from_route_idstring uuid nullable
driver_idstring uuid nullable
encoded_polylinestring nullable
ends_at_warehouseboolean
lengthnumber required
namestring
note_chain_idstring uuid nullable
notesstring
polyline_updated_atstring date-time nullable
route_group_idstring uuid required
route_idstring uuid required
start_timestring time nullable

Changes