Skip to content
Bottle

Update a vehicle

PATCH
/vehicles/{id}
curl --request PATCH \
  --url https://example.com/vehicles/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f \
  --header 'Content-Type: application/json' \
  --cookie bottle.session_token=<bottle.session_token> \
  --data '{ "name": "example", "registration": "example", "startLocationId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f", "endLocationId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f", "areas": [ "example" ], "payloadKg": 1, "volumeLitres": 1, "notes": "example", "motDueOn": "2026-04-15", "servicedOn": "2026-04-15", "serviceDueOn": "2026-04-15", "archived": true }'

Archiving gives its seat back. Bringing one back needs a seat, like adding one.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required

UUID v7

string format: uuid
Example
019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

UUID v7

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
string
>= 1 characters <= 80 characters
registration
string | null
<= 16 characters
startLocationId

UUID v7

string | null format: uuid
Example
019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f
endLocationId

UUID v7

string | null format: uuid
Example
019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f
areas
Array<string>
<= 100 items
payloadKg
integer | null
<= 50000
volumeLitres
integer | null
<= 200000
notes
string | null
<= 2000 characters
motDueOn
string | null format: date
servicedOn
string | null format: date
serviceDueOn
string | null format: date
archived
boolean

Responses

Section titled “Responses”

200

Section titled “200”

Changed

Media typeapplication/json
object
id
required

UUID v7

string format: uuid
name
required
string
>= 1 characters <= 80 characters
registration
required
string | null
<= 16 characters
startLocationId
required

UUID v7

string | null format: uuid
endLocationId
required

UUID v7

string | null format: uuid
areas
required
Array<string>
payloadKg
required
integer | null
volumeLitres
required
integer | null
notes
required
string | null
motDueOn
required
string | null format: date
servicedOn
required
string | null format: date
serviceDueOn
required
string | null format: date
archivedAt
required
string | null format: date-time
usualDriverUserId
required
string | null
usualDriverName
required
string | null
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
Example
{
  "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
  "name": "Van 1",
  "registration": "KT65 ABC",
  "startLocationId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
  "endLocationId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
  "payloadKg": 1200,
  "volumeLitres": 10000
}

401

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

403

Section titled “403”

Not a member, or without the permission this needs

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

404

Section titled “404”

Not found

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

409

Section titled “409”

The plan carries no more vehicles

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

422

Section titled “422”

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string
Example
{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}