---
title: "Update a depot"
method: PATCH
path: "/depots/{depotId}"
tags: ["Depots"]
---

# Update a depot

`PATCH /depots/{depotId}`

## Request

- Base URL: `https://api.spoke.com/public/v1`
- URL: `https://api.spoke.com/public/v1/depots/{depotId}`
- Auth: HTTP basic
- TypeScript: <https://skmtc.dev/spoke/apis/spoke-api/docs/depots/:depotId/patch.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `depotId` string, required

## Request body

- object: The request body for updating a depot. All the values present in the request will update the depot value; if you wish to update only certain fields, only set them and do not set the others. Any fields not set will not be updated.
  - `name` string
  - `routeOverrides` object
    - `startAddress` object: At least one of the fields is required. If the latitude and longitude fields are set they will override any of the others.
      - `addressName` string, nullable: The name of the address. This will not be used for geocoding, and is only for the final address display purposes.
      - `addressLineOne` string, nullable: The first line of the address.
      - `addressLineTwo` string, nullable: The second line of the address.
      - `city` string, nullable: The city of the address.
      - `state` string, nullable: The state of the address.
      - `zip` string, nullable: The zip code of the address.
      - `country` string, nullable: The country of the address.
      - `latitude` number, nullable: The latitude of the address in decimal degrees.
      - `longitude` number, nullable: The longitude of the address in decimal degrees.
    - `startTime` object: Route start time
      - `hour` integer, required: Hour of the day
      - `minute` integer, required: Minute of the hour
    - `endAddress` object, nullable: At least one of the fields is required. If the latitude and longitude fields are set they will override any of the others.
      - `addressName` string, nullable: The name of the address. This will not be used for geocoding, and is only for the final address display purposes.
      - `addressLineOne` string, nullable: The first line of the address.
      - `addressLineTwo` string, nullable: The second line of the address.
      - `city` string, nullable: The city of the address.
      - `state` string, nullable: The state of the address.
      - `zip` string, nullable: The zip code of the address.
      - `country` string, nullable: The country of the address.
      - `latitude` number, nullable: The latitude of the address in decimal degrees.
      - `longitude` number, nullable: The longitude of the address in decimal degrees.
    - `endTime` object, nullable: Time of day in hours and minutes. Uses a 24 hour clock.
      - `hour` integer, required: Hour of the day
      - `minute` integer, required: Minute of the hour
    - `defaultTimeAtStop` number, nullable: Estimated time at the stop
    - `maxStops` number, nullable: Maximum number of stops per driver
    - `vehicleType` 'bike' | 'scooter' | 'car' | 'small_truck' | 'truck' | 'electric_cargo_bike', nullable: Default vehicle type
    - `roadSide` 'any' | 'left_only' | 'right_only', nullable: Attempt to visit stops on this side of the road
    - `roundTrip` boolean, nullable: Return to the startAddress at the end of the route

## Response `200`

The updated depot

- DepotSchema: A depot.
  - `id` string, required
  - `name` string, required: The name of the depot.
  - `routeOverrides` object, nullable, required
    - `startTime` object, required: Default route start time.
      - `hour` integer, required: Hour of the day
      - `minute` integer, required: Minute of the hour
    - `startAddress` object, required: The default start address for routes originating from this depot.
      - `address` string, nullable, required: The full address.
      - `addressLineOne` string, nullable, required: The first line of the address.
      - `addressLineTwo` string, nullable, required: The second line of the address.
      - `latitude` number, nullable, required: Latitude coordinate of the depot in decimal degrees.
      - `longitude` number, nullable, required: Longitude coordinate of the depot in decimal degrees.
      - `placeId` string, nullable, required: A Google PlaceID identifying the location of the depot.
      - `countryCode` string, nullable, required: The country code of the address.
    - `defaultTimeAtStop` number, nullable: Estimated time at stop in seconds.
    - `endAddress` object, nullable: The default end address for routes originating from this depot (if empty, assume a round-trip).
      - `address` string, nullable, required: The full address.
      - `addressLineOne` string, nullable, required: The first line of the address.
      - `addressLineTwo` string, nullable, required: The second line of the address.
      - `latitude` number, nullable, required: Latitude coordinate of the depot in decimal degrees.
      - `longitude` number, nullable, required: Longitude coordinate of the depot in decimal degrees.
      - `placeId` string, nullable, required: A Google PlaceID identifying the location of the depot.
      - `countryCode` string, nullable, required: The country code of the address.
    - `endTime` object, nullable: Default route end time.
      - `hour` integer, required: Hour of the day
      - `minute` integer, required: Minute of the hour
    - `maxStops` number, nullable: Max stops assigned to each driver
    - `roadSide` 'any' | 'left_only' | 'right_only', nullable: The side of the road drivers should stop at.
    - `vehicleType` 'bike' | 'scooter' | 'car' | 'small_truck' | 'truck' | 'electric_cargo_bike', nullable: Default vehicle type for new routes from this depot.
    - `roundTrip` boolean, nullable: Return to start address at end of route

## Other responses

- `400`: The request was invalid
- `401`: Unauthorized
- `404`: The provided depot id does not exist
- `500`: An internal server error occurred
- `default`: The default error model

---

[API](https://skmtc.dev/spoke/apis/spoke-api.md) - [All operations](https://skmtc.dev/spoke/apis/spoke-api/llms.txt) - [OpenAPI document](https://skmtc.dev/spoke/apis/spoke-api/revisions/a09d9194ae1c?raw)