Skip to main content

Update Vehicle

PUT /tms/vehicles/{uuid}

Description

This endpoint is used to update the details of a specific vehicle in the system. The vehicle is identified by its UUID, and the update includes various attributes such as driver information, vehicle specifications, and carrier details.

Parameters

  • uuid (string, path, required): The unique identifier of the vehicle.
  • tenantId (string, header, required): The ID of the tenant.
  • countryCode (string, header, required): The country code relevant to the vehicle.

Request Body

  • Media Type: application/json

Example Value

{
"driverUserId": "string",
"carrierPhoneNumber": "string",
"licensePlate": "string",
"model": "string",
"manufacturer": "string",
"capacity": "string",
"colour": "string",
"year": "string",
"type": "string",
"imageUrl": "string",
"assignDriver": true,
"carrierId": "string",
"condition": "string"
}

Responses

Success Response (200)

The Success Response (200) is returned when the vehicle details are successfully updated.

Response Fields

FieldTypeDescription
statusbooleanIndicates the success of the vehicle update request.
statusCodeintegerNumeric code representing the status of the response (e.g., 0 for success).
messagestringA message indicating the outcome of the operation.
dataobjectContains updated vehicle details.
errorsarrayAn array of objects providing details about any errors encountered during the request.

Example values

{
"status": true,
"statusCode": 0,
"message": "Vehicle updated successfully",
"data": {},
"errors": [
{
"message": "string",
"descriptiveMessage": "string"
}
]
}

400

Invalid request

No links

404

Resource not found

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST


curl --request PUT \ 
--url /tms/vehicles/{uuid} \
--header 'accept: application/json' \
--header 'content-type: application/json'

RESPONSE


Click Try It! to start a request and see the response here!