*REST API › Endpoint reference › Operations › Vehicles*

# Update a vehicle

> Updates a vehicle (send only the fields to change).

It is the endpoint for a fleet integration: operational status, license plate, seats, payload, cargo space dimensions and next inspection date. The cost per kilometer and the fixed cost are NOT part of the public contract. Returns the updated vehicle.

`PATCH /api/v1/vehicles/{vehicleId}` — scope `vehicles:write`

Scope: `vehicles:write` · 120/min · Strict tenancy · Idempotency-Key · If-Match · MCP: `filmo_vehicles_update`

## Authorizations

Bearer API key with the scope below. `vehicles:write`

## Headers

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `Idempotency-Key` | string | No | Unique identifier of the request, chosen by the client (a UUID works). Between 1 and 255 characters: an empty header is rejected with 400 `validation_error`, because the client would believe itself protected. Repeating the same key with the SAME body within 24 h returns the stored response without executing again, with the `Idempotent-Replay: true` header. With a DIFFERENT body it returns 422. It is the safe way to retry after a network timeout. |
| `If-Match` | string | No | Optimistic locking: the `ETag` you read from the resource (or `*`). If the resource changed since, the write is rejected with `412 precondition_failed` before doing anything; read it again and retry. Without the header the write always proceeds. |

## Path parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `vehicleId` | string | Yes | Vehicle identifier. |

## Body

Body schema: `VehicleUpdateBody`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | No | Vehicle name. |
| `description` | string | No | Vehicle description or notes. |
| `status` | string | No | Vehicle status. `active`, `maintenance`, `inactive` |
| `registrationNumber` | string | No | Registration number; null clears it. |
| `seats` | integer | No | Number of seats; null clears it. |
| `payloadKg` | number | No | Payload in kilograms; null clears it. |
| `dimensions` | object | No | Cargo space dimensions. |
| `dimensions.lengthCm` | number | No | Length of the cargo space in cm. |
| `dimensions.widthCm` | number | No | Width of the cargo space in cm. |
| `dimensions.heightCm` | number | No | Height of the cargo space in cm. |
| `dimensions.surfaceAreaM2` | number | No | Cargo area in m². |
| `collectionId` | string | No | Collection it belongs to; null removes it from any collection. |
| `tags` | string[] | No | Tags by identifier or name. Replaces the whole list. |
| `showInPlanner` | boolean | No | Whether the vehicle appears as an assignable resource in the planner. |
| `inspectionDate` | string<date-time> | No | Date of the next technical inspection, in ISO 8601 with offset; null clears it. |

## Request examples

*Update a vehicle*

**cURL**

```bash
curl https://app.filmo.io/api/v1/vehicles/vehi_8f2a1c \
  --request PATCH \
  --header "Authorization: Bearer $FILMO_API_KEY" \
  --header "Idempotency-Key: $(uuidgen 2>/dev/null || cat /proc/sys/kernel/random/uuid)" \
  --header 'Content-Type: application/json' \
  --data '{
  "status": "maintenance",
  "inspectionDate": "2027-03-14T09:00:00+01:00",
  "payloadKg": 1200,
  "dimensions": {
    "lengthCm": 320,
    "widthCm": 175,
    "heightCm": 190,
    "surfaceAreaM2": 5.6
  }
}'
```

**Node.js**

```javascript
fetch('https://app.filmo.io/api/v1/vehicles/vehi_8f2a1c', {
  method: 'PATCH',
  headers: {
    Authorization: 'Bearer YOUR_FILMO_API_KEY',
    'Idempotency-Key': crypto.randomUUID(),
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    status: 'maintenance',
    inspectionDate: '2027-03-14T09:00:00+01:00',
    payloadKg: 1200,
    dimensions: {
      lengthCm: 320,
      widthCm: 175,
      heightCm: 190,
      surfaceAreaM2: 5.6
    }
  })
})
```

**Python**

```python
import uuid
import requests

requests.patch(
    "https://app.filmo.io/api/v1/vehicles/vehi_8f2a1c",
    headers={
      "Authorization": "Bearer YOUR_FILMO_API_KEY",
      "Idempotency-Key": str(uuid.uuid4()),
      "Content-Type": "application/json"
    },
    json={
      "status": "maintenance",
      "inspectionDate": "2027-03-14T09:00:00+01:00",
      "payloadKg": 1200,
      "dimensions": {
        "lengthCm": 320,
        "widthCm": 175,
        "heightCm": 190,
        "surfaceAreaM2": 5.6
      }
    }
)
```

## Response

Response schema: `VehicleDto`

| Status | Description |
| --- | --- |
| 200 | Successful response. |
| 400 | Invalid request (validation_error): malformed query or body. `errors[]` lists every offending field with its stable code. |
| 401 | Authentication failed (unauthorized, api_key_invalid, api_key_revoked, api_key_expired, api_key_owner_inactive, api_key_owner_not_admin). |
| 403 | Not allowed (insufficient_scope: the API key does not have the required scope, named in `requiredScope`; forbidden: the owner of the key lacks the permission the operation requires). `insufficient_scope` is answered before the request counts against the rate limit, so it carries no `RateLimit-*` headers; `forbidden` does. |
| 404 | Resource not found (not_found): it does not exist or is outside the scope of the API key. |
| 409 | Conflict (conflict): the current state of the resource prevents the operation, a request with that Idempotency-Key is already in progress, or another conditional write (`If-Match`) held the resource for more than five seconds. `errors[0].code` says which: `in_progress` and `lock_timeout` are solved by retrying; `invalid_state` is not, because the state of the resource forbids the operation. |
| 412 | Precondition failed (precondition_failed): the `If-Match` entity tag does not match the current representation. Read the resource again and retry. |
| 422 | Idempotency-Key reused (idempotency_key_reused): the same key was used before with a different body. Change the key. |
| 429 | Rate limit exceeded (rate_limited): retry after `Retry-After` seconds; `RateLimit-*` says which quota ran out. |
| 500 | Internal error (internal_error). |

**200**

| Name | Type | Description |
| --- | --- | --- |
| `data` | object | Fleet vehicle. Does not include operating costs or pricing settings. |
| `data.id` | string | Unique vehicle identifier. |
| `data.name` | string | Vehicle name. |
| `data.status` | string | Operational status: active (available), maintenance (in the workshop) or inactive (out of service). `active`, `maintenance`, `inactive` |
| `data.registrationNumber` | string | Registration number; null if not recorded. |
| `data.seats` | number | Seats, including the driver seat; null if not recorded. |
| `data.payloadKg` | number | Payload in kilograms; null if not recorded. |
| `data.inspectionDate` | string<date-time> | Date of the next technical inspection in ISO 8601 UTC; null if not recorded. |
| `data.collectionId` | string | Identifier of the collection it belongs to; null if it is in none. |
| `data.collectionName` | string | Collection path; null if not applicable. |
| `data.showInPlanner` | boolean | true if it appears in the planner of the account. |
| `data.createdAt` | string<date-time> | Creation date in ISO 8601 UTC; null if not recorded. |
| `data.updatedAt` | string<date-time> | Last modification date in ISO 8601 UTC; null if not recorded. |
| `meta` | object | Additional information about the response. |
| `meta.warnings` | object[] | Lifecycle warnings; present only when the operation is deprecated. |
| `meta.warnings.code` | string | Stable warning code. `deprecated` |
| `meta.warnings.message` | string | For people: what is deprecated, until when, and what to use. |
| `meta.warnings.sunset` | string | Day (YYYY-MM-DD) the operation stops being served. |
| `meta.warnings.replacement` | string | `operationId` of the operation to use instead, or null if there is none. |
| `meta.warnings.link` | string | Where the deprecation is documented (the changelog). |

*Example response · 200*

```json
{
  "data": {
    "id": "vehicle_9f3a2b",
    "name": "Example vehicle",
    "status": "active",
    "registrationNumber": "2026-0001",
    "seats": 1,
    "payloadKg": 1,
    "inspectionDate": "2026-09-01T08:00:00.000Z",
    "collectionId": "collection_9f3a2b",
    "collectionName": "Example collection name",
    "showInPlanner": true,
    "createdAt": "2026-09-01T08:00:00.000Z",
    "updatedAt": "2026-09-01T08:00:00.000Z"
  }
}
```

## Errors

| Status | Codes | Meaning |
| --- | --- | --- |
| 400 | `validation_error` | Malformed query or body. `errors[]` lists every offending field with its stable code. |
| 404 | `not_found` | It does not exist or is outside the scope of the API key. |
| 409 | `conflict` | The current state of the resource prevents the operation, a request with that Idempotency-Key is already in progress, or another conditional write (`If-Match`) held the resource for more than five seconds. `errors[0].code` says which: `in_progress` and `lock_timeout` are solved by retrying; `invalid_state` is not, because the state of the resource forbids the operation. |
| 412 | `precondition_failed` | The `If-Match` entity tag does not match the current representation. Read the resource again and retry. |
| 422 | `idempotency_key_reused` | The same key was used before with a different body. Change the key. |

## Deprecation

This operation is not deprecated. Deprecations are announced with a Deprecation header and a sunset date.

---

Canonical URL: https://docs.filmo.io/rest-api/endpoint-reference/vehicles/update-a-vehicle  
Last updated: 2026-10-25