Skip to main content

PATCH Vehicle Status

This endpoint allows you to update the status of a specific vehicle identified by its VIN. Changes are applied immediately to manage the vehicle's lifecycle (e.g., active, inactive, stolen, in maintenance, or sold).

Operational Impact

Setting a vehicle's status to anything other than Active will "deactivate" it across the platform. This means the vehicle will be automatically excluded from platform operations.

Request

HTTP request

PATCH https://api-sync-resser.azurewebsites.net/api/v2/vehicles/{vin}/status
  • {vin} is the vehicle's vin.
VIN Format Requirements
  • VIN must be exactly 17 characters
  • Must follow the VIN standard (no I, O, or Q characters)
  • Must not contain hyphens, spaces, or special characters
  • Case-insensitive (will be normalized to uppercase)

Parameters

This particular request does not utilize any query parameters in its execution.

Request body

Provide an object like the below one:

{
"vehicleStatusId": number
}
  • Required: vehicleStatusId must be provided.
  • Type: Must be a valid integer, not a string.
  • Valid values: A valid vehicle status ID (excluding 2, which is system-managed). For the complete list of available status IDs and their definitions, please refer to the vehicle statuses reference.

Response

If successful, this method returns 204 No Content with no response body, indicating the status was updated successfully.

Errors

The following table provides a list of potential error messages that the API may return in response to a call to this method. For more detailed information, please refer to the error message documentation.

Error typeError detailDescription
badRequest (400)BadParameters- Invalid VIN format (length, forbidden characters, special characters)
- Invalid vehicleStatusId value (must be 0-9, excluding 2)
- Missing or malformed request body
unauthorized (401)UnauthorizedThe requester is not authenticated or the token is invalid.
forbidden (403)ForbiddenRequester does not have permission to perform this operation on the resource.
notFound (404)VehicleNotFoundNo active vehicle found with the provided VIN for the authenticated user.
conflict (409)MultipleVehiclesFoundMultiple active vehicles found with the same VIN (contact support).
Notes
  • The vehicle must belong to the authenticated user to be updated
  • Only one active vehicle per VIN is allowed per user
  • Status ID 2 (Información cambiada) is reserved for system use and cannot be set via this endpoint
  • Updating to the same current status will still return 204 No Content