---
title: "Update route by id"
method: PATCH
path: "/routes/{id}"
tags: ["Routes"]
---

# Update route by id

`PATCH /routes/{id}`

Update route by id

## Path parameters

- `id` integer, required

## Request body

- object
  - `code` string — Route code
  - `startDate` string, date-time — Route start date
  - `date` string, date — Route scheduled date
  - `status` 'overdue' | 'finished' | 'extended' | 'pending' | 'closed' | 'ongoing' — Route state
  - `deviceId` number — Route assigned vehicle
  - `totalAmount` number — Route total amount
  - `driverId` number — Route driver id
  - `companionId` number — Route companion id
  - `secondaryCode` string — Route secondary code
  - `warehouseDepartureDate` string, date-time — Warehouse departure date
  - `warehouseReturnDate` string, date-time — Warehouse return date
  - `carrier` string — Route carrier
  - `scheduledStartDate` string, date-time — Route scheduled date
  - `recalculatedAt` string, date-time — Route recalculated date
  - `optimized` boolean — Route is optimized
  - `assignedDeviceIMEI` number — Route assigned device IMEI
  - `routePrediction` object
    - `_id` integer
    - `routeId` integer
    - `estimatedReturnDate` string
    - `realReturnDate` string
    - `initialReturnDate` string
    - `estimatedDepartureDate` string
    - `estimatedKms` number
    - `executedKms` number
    - `optimizedOn` string

## Response `200`

Updated route

- object
  - `meta` object
    - `error` number — Error number
    - `message` string — Error message
  - `data` object
    - `code` string — Route code
    - `startDate` string, date-time — Route start date
    - `date` string, date — Route scheduled date
    - `status` 'overdue' | 'finished' | 'extended' | 'pending' | 'closed' | 'ongoing' — Route state
    - `deviceId` number — Route assigned vehicle
    - `totalAmount` number — Route total amount
    - `driverId` number — Route driver id
    - `companionId` number — Route companion id
    - `secondaryCode` string — Route secondary code
    - `warehouseDepartureDate` string, date-time — Warehouse departure date
    - `warehouseReturnDate` string, date-time — Warehouse return date
    - `carrier` string — Route carrier
    - `scheduledStartDate` string, date-time — Route scheduled date
    - `recalculatedAt` string, date-time — Route recalculated date
    - `optimized` boolean — Route is optimized
    - `assignedDeviceIMEI` number — Route assigned device IMEI
    - `routePrediction` object
      - `_id` integer
      - `routeId` integer
      - `estimatedReturnDate` string
      - `realReturnDate` string
      - `initialReturnDate` string
      - `estimatedDepartureDate` string
      - `estimatedKms` number
      - `executedKms` number
      - `optimizedOn` string

## Other responses

- `400` — On Error, response will contain an error and message with these posible values ### Error codes: Code | Description | Field ----------------|-------------|------------- 2010 | Activity type not found or not allowed for this user | 2021 | Poi code not found or not allowed for this user | 2022 | Order code not found or not allowed for this user | 2040 | Driver id not found or not allowed for this user | 2041 | Companion id not found or not allowed for this user | 2042 | Device id not found or not allowed for this user | 2043 | Invalid status | 2044 | Driver's id and companion's id can't be equals |
- `403` — Not authorized access
- `404` — Not found

---

[API](https://skmtc.net/quadminds/apis/quadminds-api-v2.md) · [All operations](https://skmtc.net/quadminds/apis/quadminds-api-v2/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/quadminds/quadminds-api-v2/versions/e0ab56dece05/schema)
