Update vehicle profile

Updates information in the specified vehicle profile. Note that all fields are optional, i.e., a partial view of the request body may be given.

PUT /vehicle/{vehicle_id}

Update vehicle profile

cURL

curl --request PUT \
  --url https://ctechnology.io/api/v2.2/vehicle/{vehicle_id} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "bluetooth_address": "<string>",
  "name": "<string>",
  "brand": "<string>",
  "type": "<string>",
  "desc": "<string>",
  "description": "<string>",
  "image_id": "<string>",
  "primary_organization_id": "<string>",
  "manufacturing_organization_id": "<string>",
  "professional_vehicle_id": "<string>",
  "professional_vehicle_name": "<string>",
  "professional_location_main_lon": 123,
  "professional_location_main_lat": 123,
  "professional_location_main_desc": "<string>",
  "oem_vehicle_id": "<string>",
  "oem_vehicle_type_id": "<string>",
  "vehicle_registration_id": "<string>",
  "vehicle_identification_number": "<string>",
  "ain_1_desc": "<string>",
  "ain_2_desc": "<string>",
  "ain_3_desc": "<string>",
  "ain_4_desc": "<string>",
  "din_1_desc": "<string>",
  "din_2_desc": "<string>",
  "din_3_desc": "<string>",
  "din_4_desc": "<string>",
  "din_5_desc": "<string>",
  "dout_1_desc": "<string>",
  "dout_2_desc": "<string>",
  "dout_3_desc": "<string>",
  "dout_4_desc": "<string>",
  "ble_temp_type": "<string>",
  "temp_1_desc": "<string>",
  "temp_2_desc": "<string>",
  "temp_3_desc": "<string>",
  "temp_4_desc": "<string>",
  "battery_main_desc": "<string>",
  "battery_ext_1_desc": "<string>",
  "battery_ext_2_desc": "<string>",
  "battery_ext_3_desc": "<string>",
  "battery_ext_4_desc": "<string>",
  "tank_size": 123,
  "tank_prefer_analog": true,
  "hibernation_mode": true,
  "transport_mode": true,
  "notrack_mode": true,
  "organization_vehicles": [
    {
      "organization_id": "<string>",
      "vehicle_id": "<string>",
      "vehicle_device_id": "<string>",
      "primary_organization": true,
      "manufacturing_organization": true,
      "vehicle_category_id": "<string>",
      "vehicle_category_name": "<string>",
      "vehicle_family_id": "<string>",
      "vehicle_family_name": "<string>",
      "vehicle_type_id": "<string>",
      "vehicle_type_name": "<string>",
      "vehicle_type_image_url": "<string>",
      "organization_vehicle_id": "<string>",
      "organization_vehicle_name": "<string>",
      "organization_vehicle_desc": "<string>",
      "vehicle_type_max_speed": 123,
      "vehicle_type_battery_capacity_wh": 123,
      "vehicle_type_avg_consumption_wh_per_km": 123,
      "vehicle_type_tank_capacity_l": 123,
      "vehicle_type_avg_consumption_l_per_100km": 123,
      "location_main_desc": "<string>"
    }
  ],
  "initial_distance": 123,
  "initial_operation_hours": 123,
  "initial_date": "2023-12-25",
  "initialization_complete": true,
  "auto_discover_home": true,
  "trips_end_at_home": true,
  "remove_trip_points_on_land": true,
  "vehicle_length_m": 123,
  "vehicle_depth_m": 123,
  "vehicle_height_m": 123,
  "vehicle_weight_kg": 123,
  "main_battery_property_pct": "<string>",
  "main_fuel_property_pct": "<string>",
  "display_settings": {
    "webapp_sidebar_slot_1": "<string>",
    "webapp_sidebar_slot_2": "<string>",
    "nativeapp_dashboard_main": "<string>",
    "nativeapp_four_most_important_1": "<string>",
    "nativeapp_four_most_important_2": "<string>",
    "nativeapp_four_most_important_3": "<string>",
    "nativeapp_four_most_important_4": "<string>"
  }
}
'

import requests

url = "https://ctechnology.io/api/v2.2/vehicle/{vehicle_id}"

payload = {
    "bluetooth_address": "<string>",
    "name": "<string>",
    "brand": "<string>",
    "type": "<string>",
    "desc": "<string>",
    "description": "<string>",
    "image_id": "<string>",
    "primary_organization_id": "<string>",
    "manufacturing_organization_id": "<string>",
    "professional_vehicle_id": "<string>",
    "professional_vehicle_name": "<string>",
    "professional_location_main_lon": 123,
    "professional_location_main_lat": 123,
    "professional_location_main_desc": "<string>",
    "oem_vehicle_id": "<string>",
    "oem_vehicle_type_id": "<string>",
    "vehicle_registration_id": "<string>",
    "vehicle_identification_number": "<string>",
    "ain_1_desc": "<string>",
    "ain_2_desc": "<string>",
    "ain_3_desc": "<string>",
    "ain_4_desc": "<string>",
    "din_1_desc": "<string>",
    "din_2_desc": "<string>",
    "din_3_desc": "<string>",
    "din_4_desc": "<string>",
    "din_5_desc": "<string>",
    "dout_1_desc": "<string>",
    "dout_2_desc": "<string>",
    "dout_3_desc": "<string>",
    "dout_4_desc": "<string>",
    "ble_temp_type": "<string>",
    "temp_1_desc": "<string>",
    "temp_2_desc": "<string>",
    "temp_3_desc": "<string>",
    "temp_4_desc": "<string>",
    "battery_main_desc": "<string>",
    "battery_ext_1_desc": "<string>",
    "battery_ext_2_desc": "<string>",
    "battery_ext_3_desc": "<string>",
    "battery_ext_4_desc": "<string>",
    "tank_size": 123,
    "tank_prefer_analog": True,
    "hibernation_mode": True,
    "transport_mode": True,
    "notrack_mode": True,
    "organization_vehicles": [
        {
            "organization_id": "<string>",
            "vehicle_id": "<string>",
            "vehicle_device_id": "<string>",
            "primary_organization": True,
            "manufacturing_organization": True,
            "vehicle_category_id": "<string>",
            "vehicle_category_name": "<string>",
            "vehicle_family_id": "<string>",
            "vehicle_family_name": "<string>",
            "vehicle_type_id": "<string>",
            "vehicle_type_name": "<string>",
            "vehicle_type_image_url": "<string>",
            "organization_vehicle_id": "<string>",
            "organization_vehicle_name": "<string>",
            "organization_vehicle_desc": "<string>",
            "vehicle_type_max_speed": 123,
            "vehicle_type_battery_capacity_wh": 123,
            "vehicle_type_avg_consumption_wh_per_km": 123,
            "vehicle_type_tank_capacity_l": 123,
            "vehicle_type_avg_consumption_l_per_100km": 123,
            "location_main_desc": "<string>"
        }
    ],
    "initial_distance": 123,
    "initial_operation_hours": 123,
    "initial_date": "2023-12-25",
    "initialization_complete": True,
    "auto_discover_home": True,
    "trips_end_at_home": True,
    "remove_trip_points_on_land": True,
    "vehicle_length_m": 123,
    "vehicle_depth_m": 123,
    "vehicle_height_m": 123,
    "vehicle_weight_kg": 123,
    "main_battery_property_pct": "<string>",
    "main_fuel_property_pct": "<string>",
    "display_settings": {
        "webapp_sidebar_slot_1": "<string>",
        "webapp_sidebar_slot_2": "<string>",
        "nativeapp_dashboard_main": "<string>",
        "nativeapp_four_most_important_1": "<string>",
        "nativeapp_four_most_important_2": "<string>",
        "nativeapp_four_most_important_3": "<string>",
        "nativeapp_four_most_important_4": "<string>"
    }
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    bluetooth_address: '<string>',
    name: '<string>',
    brand: '<string>',
    type: '<string>',
    desc: '<string>',
    description: '<string>',
    image_id: '<string>',
    primary_organization_id: '<string>',
    manufacturing_organization_id: '<string>',
    professional_vehicle_id: '<string>',
    professional_vehicle_name: '<string>',
    professional_location_main_lon: 123,
    professional_location_main_lat: 123,
    professional_location_main_desc: '<string>',
    oem_vehicle_id: '<string>',
    oem_vehicle_type_id: '<string>',
    vehicle_registration_id: '<string>',
    vehicle_identification_number: '<string>',
    ain_1_desc: '<string>',
    ain_2_desc: '<string>',
    ain_3_desc: '<string>',
    ain_4_desc: '<string>',
    din_1_desc: '<string>',
    din_2_desc: '<string>',
    din_3_desc: '<string>',
    din_4_desc: '<string>',
    din_5_desc: '<string>',
    dout_1_desc: '<string>',
    dout_2_desc: '<string>',
    dout_3_desc: '<string>',
    dout_4_desc: '<string>',
    ble_temp_type: '<string>',
    temp_1_desc: '<string>',
    temp_2_desc: '<string>',
    temp_3_desc: '<string>',
    temp_4_desc: '<string>',
    battery_main_desc: '<string>',
    battery_ext_1_desc: '<string>',
    battery_ext_2_desc: '<string>',
    battery_ext_3_desc: '<string>',
    battery_ext_4_desc: '<string>',
    tank_size: 123,
    tank_prefer_analog: true,
    hibernation_mode: true,
    transport_mode: true,
    notrack_mode: true,
    organization_vehicles: [
      {
        organization_id: '<string>',
        vehicle_id: '<string>',
        vehicle_device_id: '<string>',
        primary_organization: true,
        manufacturing_organization: true,
        vehicle_category_id: '<string>',
        vehicle_category_name: '<string>',
        vehicle_family_id: '<string>',
        vehicle_family_name: '<string>',
        vehicle_type_id: '<string>',
        vehicle_type_name: '<string>',
        vehicle_type_image_url: '<string>',
        organization_vehicle_id: '<string>',
        organization_vehicle_name: '<string>',
        organization_vehicle_desc: '<string>',
        vehicle_type_max_speed: 123,
        vehicle_type_battery_capacity_wh: 123,
        vehicle_type_avg_consumption_wh_per_km: 123,
        vehicle_type_tank_capacity_l: 123,
        vehicle_type_avg_consumption_l_per_100km: 123,
        location_main_desc: '<string>'
      }
    ],
    initial_distance: 123,
    initial_operation_hours: 123,
    initial_date: '2023-12-25',
    initialization_complete: true,
    auto_discover_home: true,
    trips_end_at_home: true,
    remove_trip_points_on_land: true,
    vehicle_length_m: 123,
    vehicle_depth_m: 123,
    vehicle_height_m: 123,
    vehicle_weight_kg: 123,
    main_battery_property_pct: '<string>',
    main_fuel_property_pct: '<string>',
    display_settings: {
      webapp_sidebar_slot_1: '<string>',
      webapp_sidebar_slot_2: '<string>',
      nativeapp_dashboard_main: '<string>',
      nativeapp_four_most_important_1: '<string>',
      nativeapp_four_most_important_2: '<string>',
      nativeapp_four_most_important_3: '<string>',
      nativeapp_four_most_important_4: '<string>'
    }
  })
};

fetch('https://ctechnology.io/api/v2.2/vehicle/{vehicle_id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://ctechnology.io/api/v2.2/vehicle/{vehicle_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'bluetooth_address' => '<string>',
    'name' => '<string>',
    'brand' => '<string>',
    'type' => '<string>',
    'desc' => '<string>',
    'description' => '<string>',
    'image_id' => '<string>',
    'primary_organization_id' => '<string>',
    'manufacturing_organization_id' => '<string>',
    'professional_vehicle_id' => '<string>',
    'professional_vehicle_name' => '<string>',
    'professional_location_main_lon' => 123,
    'professional_location_main_lat' => 123,
    'professional_location_main_desc' => '<string>',
    'oem_vehicle_id' => '<string>',
    'oem_vehicle_type_id' => '<string>',
    'vehicle_registration_id' => '<string>',
    'vehicle_identification_number' => '<string>',
    'ain_1_desc' => '<string>',
    'ain_2_desc' => '<string>',
    'ain_3_desc' => '<string>',
    'ain_4_desc' => '<string>',
    'din_1_desc' => '<string>',
    'din_2_desc' => '<string>',
    'din_3_desc' => '<string>',
    'din_4_desc' => '<string>',
    'din_5_desc' => '<string>',
    'dout_1_desc' => '<string>',
    'dout_2_desc' => '<string>',
    'dout_3_desc' => '<string>',
    'dout_4_desc' => '<string>',
    'ble_temp_type' => '<string>',
    'temp_1_desc' => '<string>',
    'temp_2_desc' => '<string>',
    'temp_3_desc' => '<string>',
    'temp_4_desc' => '<string>',
    'battery_main_desc' => '<string>',
    'battery_ext_1_desc' => '<string>',
    'battery_ext_2_desc' => '<string>',
    'battery_ext_3_desc' => '<string>',
    'battery_ext_4_desc' => '<string>',
    'tank_size' => 123,
    'tank_prefer_analog' => true,
    'hibernation_mode' => true,
    'transport_mode' => true,
    'notrack_mode' => true,
    'organization_vehicles' => [
        [
                'organization_id' => '<string>',
                'vehicle_id' => '<string>',
                'vehicle_device_id' => '<string>',
                'primary_organization' => true,
                'manufacturing_organization' => true,
                'vehicle_category_id' => '<string>',
                'vehicle_category_name' => '<string>',
                'vehicle_family_id' => '<string>',
                'vehicle_family_name' => '<string>',
                'vehicle_type_id' => '<string>',
                'vehicle_type_name' => '<string>',
                'vehicle_type_image_url' => '<string>',
                'organization_vehicle_id' => '<string>',
                'organization_vehicle_name' => '<string>',
                'organization_vehicle_desc' => '<string>',
                'vehicle_type_max_speed' => 123,
                'vehicle_type_battery_capacity_wh' => 123,
                'vehicle_type_avg_consumption_wh_per_km' => 123,
                'vehicle_type_tank_capacity_l' => 123,
                'vehicle_type_avg_consumption_l_per_100km' => 123,
                'location_main_desc' => '<string>'
        ]
    ],
    'initial_distance' => 123,
    'initial_operation_hours' => 123,
    'initial_date' => '2023-12-25',
    'initialization_complete' => true,
    'auto_discover_home' => true,
    'trips_end_at_home' => true,
    'remove_trip_points_on_land' => true,
    'vehicle_length_m' => 123,
    'vehicle_depth_m' => 123,
    'vehicle_height_m' => 123,
    'vehicle_weight_kg' => 123,
    'main_battery_property_pct' => '<string>',
    'main_fuel_property_pct' => '<string>',
    'display_settings' => [
        'webapp_sidebar_slot_1' => '<string>',
        'webapp_sidebar_slot_2' => '<string>',
        'nativeapp_dashboard_main' => '<string>',
        'nativeapp_four_most_important_1' => '<string>',
        'nativeapp_four_most_important_2' => '<string>',
        'nativeapp_four_most_important_3' => '<string>',
        'nativeapp_four_most_important_4' => '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://ctechnology.io/api/v2.2/vehicle/{vehicle_id}"

	payload := strings.NewReader("{\n  \"bluetooth_address\": \"<string>\",\n  \"name\": \"<string>\",\n  \"brand\": \"<string>\",\n  \"type\": \"<string>\",\n  \"desc\": \"<string>\",\n  \"description\": \"<string>\",\n  \"image_id\": \"<string>\",\n  \"primary_organization_id\": \"<string>\",\n  \"manufacturing_organization_id\": \"<string>\",\n  \"professional_vehicle_id\": \"<string>\",\n  \"professional_vehicle_name\": \"<string>\",\n  \"professional_location_main_lon\": 123,\n  \"professional_location_main_lat\": 123,\n  \"professional_location_main_desc\": \"<string>\",\n  \"oem_vehicle_id\": \"<string>\",\n  \"oem_vehicle_type_id\": \"<string>\",\n  \"vehicle_registration_id\": \"<string>\",\n  \"vehicle_identification_number\": \"<string>\",\n  \"ain_1_desc\": \"<string>\",\n  \"ain_2_desc\": \"<string>\",\n  \"ain_3_desc\": \"<string>\",\n  \"ain_4_desc\": \"<string>\",\n  \"din_1_desc\": \"<string>\",\n  \"din_2_desc\": \"<string>\",\n  \"din_3_desc\": \"<string>\",\n  \"din_4_desc\": \"<string>\",\n  \"din_5_desc\": \"<string>\",\n  \"dout_1_desc\": \"<string>\",\n  \"dout_2_desc\": \"<string>\",\n  \"dout_3_desc\": \"<string>\",\n  \"dout_4_desc\": \"<string>\",\n  \"ble_temp_type\": \"<string>\",\n  \"temp_1_desc\": \"<string>\",\n  \"temp_2_desc\": \"<string>\",\n  \"temp_3_desc\": \"<string>\",\n  \"temp_4_desc\": \"<string>\",\n  \"battery_main_desc\": \"<string>\",\n  \"battery_ext_1_desc\": \"<string>\",\n  \"battery_ext_2_desc\": \"<string>\",\n  \"battery_ext_3_desc\": \"<string>\",\n  \"battery_ext_4_desc\": \"<string>\",\n  \"tank_size\": 123,\n  \"tank_prefer_analog\": true,\n  \"hibernation_mode\": true,\n  \"transport_mode\": true,\n  \"notrack_mode\": true,\n  \"organization_vehicles\": [\n    {\n      \"organization_id\": \"<string>\",\n      \"vehicle_id\": \"<string>\",\n      \"vehicle_device_id\": \"<string>\",\n      \"primary_organization\": true,\n      \"manufacturing_organization\": true,\n      \"vehicle_category_id\": \"<string>\",\n      \"vehicle_category_name\": \"<string>\",\n      \"vehicle_family_id\": \"<string>\",\n      \"vehicle_family_name\": \"<string>\",\n      \"vehicle_type_id\": \"<string>\",\n      \"vehicle_type_name\": \"<string>\",\n      \"vehicle_type_image_url\": \"<string>\",\n      \"organization_vehicle_id\": \"<string>\",\n      \"organization_vehicle_name\": \"<string>\",\n      \"organization_vehicle_desc\": \"<string>\",\n      \"vehicle_type_max_speed\": 123,\n      \"vehicle_type_battery_capacity_wh\": 123,\n      \"vehicle_type_avg_consumption_wh_per_km\": 123,\n      \"vehicle_type_tank_capacity_l\": 123,\n      \"vehicle_type_avg_consumption_l_per_100km\": 123,\n      \"location_main_desc\": \"<string>\"\n    }\n  ],\n  \"initial_distance\": 123,\n  \"initial_operation_hours\": 123,\n  \"initial_date\": \"2023-12-25\",\n  \"initialization_complete\": true,\n  \"auto_discover_home\": true,\n  \"trips_end_at_home\": true,\n  \"remove_trip_points_on_land\": true,\n  \"vehicle_length_m\": 123,\n  \"vehicle_depth_m\": 123,\n  \"vehicle_height_m\": 123,\n  \"vehicle_weight_kg\": 123,\n  \"main_battery_property_pct\": \"<string>\",\n  \"main_fuel_property_pct\": \"<string>\",\n  \"display_settings\": {\n    \"webapp_sidebar_slot_1\": \"<string>\",\n    \"webapp_sidebar_slot_2\": \"<string>\",\n    \"nativeapp_dashboard_main\": \"<string>\",\n    \"nativeapp_four_most_important_1\": \"<string>\",\n    \"nativeapp_four_most_important_2\": \"<string>\",\n    \"nativeapp_four_most_important_3\": \"<string>\",\n    \"nativeapp_four_most_important_4\": \"<string>\"\n  }\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://ctechnology.io/api/v2.2/vehicle/{vehicle_id}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"bluetooth_address\": \"<string>\",\n  \"name\": \"<string>\",\n  \"brand\": \"<string>\",\n  \"type\": \"<string>\",\n  \"desc\": \"<string>\",\n  \"description\": \"<string>\",\n  \"image_id\": \"<string>\",\n  \"primary_organization_id\": \"<string>\",\n  \"manufacturing_organization_id\": \"<string>\",\n  \"professional_vehicle_id\": \"<string>\",\n  \"professional_vehicle_name\": \"<string>\",\n  \"professional_location_main_lon\": 123,\n  \"professional_location_main_lat\": 123,\n  \"professional_location_main_desc\": \"<string>\",\n  \"oem_vehicle_id\": \"<string>\",\n  \"oem_vehicle_type_id\": \"<string>\",\n  \"vehicle_registration_id\": \"<string>\",\n  \"vehicle_identification_number\": \"<string>\",\n  \"ain_1_desc\": \"<string>\",\n  \"ain_2_desc\": \"<string>\",\n  \"ain_3_desc\": \"<string>\",\n  \"ain_4_desc\": \"<string>\",\n  \"din_1_desc\": \"<string>\",\n  \"din_2_desc\": \"<string>\",\n  \"din_3_desc\": \"<string>\",\n  \"din_4_desc\": \"<string>\",\n  \"din_5_desc\": \"<string>\",\n  \"dout_1_desc\": \"<string>\",\n  \"dout_2_desc\": \"<string>\",\n  \"dout_3_desc\": \"<string>\",\n  \"dout_4_desc\": \"<string>\",\n  \"ble_temp_type\": \"<string>\",\n  \"temp_1_desc\": \"<string>\",\n  \"temp_2_desc\": \"<string>\",\n  \"temp_3_desc\": \"<string>\",\n  \"temp_4_desc\": \"<string>\",\n  \"battery_main_desc\": \"<string>\",\n  \"battery_ext_1_desc\": \"<string>\",\n  \"battery_ext_2_desc\": \"<string>\",\n  \"battery_ext_3_desc\": \"<string>\",\n  \"battery_ext_4_desc\": \"<string>\",\n  \"tank_size\": 123,\n  \"tank_prefer_analog\": true,\n  \"hibernation_mode\": true,\n  \"transport_mode\": true,\n  \"notrack_mode\": true,\n  \"organization_vehicles\": [\n    {\n      \"organization_id\": \"<string>\",\n      \"vehicle_id\": \"<string>\",\n      \"vehicle_device_id\": \"<string>\",\n      \"primary_organization\": true,\n      \"manufacturing_organization\": true,\n      \"vehicle_category_id\": \"<string>\",\n      \"vehicle_category_name\": \"<string>\",\n      \"vehicle_family_id\": \"<string>\",\n      \"vehicle_family_name\": \"<string>\",\n      \"vehicle_type_id\": \"<string>\",\n      \"vehicle_type_name\": \"<string>\",\n      \"vehicle_type_image_url\": \"<string>\",\n      \"organization_vehicle_id\": \"<string>\",\n      \"organization_vehicle_name\": \"<string>\",\n      \"organization_vehicle_desc\": \"<string>\",\n      \"vehicle_type_max_speed\": 123,\n      \"vehicle_type_battery_capacity_wh\": 123,\n      \"vehicle_type_avg_consumption_wh_per_km\": 123,\n      \"vehicle_type_tank_capacity_l\": 123,\n      \"vehicle_type_avg_consumption_l_per_100km\": 123,\n      \"location_main_desc\": \"<string>\"\n    }\n  ],\n  \"initial_distance\": 123,\n  \"initial_operation_hours\": 123,\n  \"initial_date\": \"2023-12-25\",\n  \"initialization_complete\": true,\n  \"auto_discover_home\": true,\n  \"trips_end_at_home\": true,\n  \"remove_trip_points_on_land\": true,\n  \"vehicle_length_m\": 123,\n  \"vehicle_depth_m\": 123,\n  \"vehicle_height_m\": 123,\n  \"vehicle_weight_kg\": 123,\n  \"main_battery_property_pct\": \"<string>\",\n  \"main_fuel_property_pct\": \"<string>\",\n  \"display_settings\": {\n    \"webapp_sidebar_slot_1\": \"<string>\",\n    \"webapp_sidebar_slot_2\": \"<string>\",\n    \"nativeapp_dashboard_main\": \"<string>\",\n    \"nativeapp_four_most_important_1\": \"<string>\",\n    \"nativeapp_four_most_important_2\": \"<string>\",\n    \"nativeapp_four_most_important_3\": \"<string>\",\n    \"nativeapp_four_most_important_4\": \"<string>\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://ctechnology.io/api/v2.2/vehicle/{vehicle_id}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"bluetooth_address\": \"<string>\",\n  \"name\": \"<string>\",\n  \"brand\": \"<string>\",\n  \"type\": \"<string>\",\n  \"desc\": \"<string>\",\n  \"description\": \"<string>\",\n  \"image_id\": \"<string>\",\n  \"primary_organization_id\": \"<string>\",\n  \"manufacturing_organization_id\": \"<string>\",\n  \"professional_vehicle_id\": \"<string>\",\n  \"professional_vehicle_name\": \"<string>\",\n  \"professional_location_main_lon\": 123,\n  \"professional_location_main_lat\": 123,\n  \"professional_location_main_desc\": \"<string>\",\n  \"oem_vehicle_id\": \"<string>\",\n  \"oem_vehicle_type_id\": \"<string>\",\n  \"vehicle_registration_id\": \"<string>\",\n  \"vehicle_identification_number\": \"<string>\",\n  \"ain_1_desc\": \"<string>\",\n  \"ain_2_desc\": \"<string>\",\n  \"ain_3_desc\": \"<string>\",\n  \"ain_4_desc\": \"<string>\",\n  \"din_1_desc\": \"<string>\",\n  \"din_2_desc\": \"<string>\",\n  \"din_3_desc\": \"<string>\",\n  \"din_4_desc\": \"<string>\",\n  \"din_5_desc\": \"<string>\",\n  \"dout_1_desc\": \"<string>\",\n  \"dout_2_desc\": \"<string>\",\n  \"dout_3_desc\": \"<string>\",\n  \"dout_4_desc\": \"<string>\",\n  \"ble_temp_type\": \"<string>\",\n  \"temp_1_desc\": \"<string>\",\n  \"temp_2_desc\": \"<string>\",\n  \"temp_3_desc\": \"<string>\",\n  \"temp_4_desc\": \"<string>\",\n  \"battery_main_desc\": \"<string>\",\n  \"battery_ext_1_desc\": \"<string>\",\n  \"battery_ext_2_desc\": \"<string>\",\n  \"battery_ext_3_desc\": \"<string>\",\n  \"battery_ext_4_desc\": \"<string>\",\n  \"tank_size\": 123,\n  \"tank_prefer_analog\": true,\n  \"hibernation_mode\": true,\n  \"transport_mode\": true,\n  \"notrack_mode\": true,\n  \"organization_vehicles\": [\n    {\n      \"organization_id\": \"<string>\",\n      \"vehicle_id\": \"<string>\",\n      \"vehicle_device_id\": \"<string>\",\n      \"primary_organization\": true,\n      \"manufacturing_organization\": true,\n      \"vehicle_category_id\": \"<string>\",\n      \"vehicle_category_name\": \"<string>\",\n      \"vehicle_family_id\": \"<string>\",\n      \"vehicle_family_name\": \"<string>\",\n      \"vehicle_type_id\": \"<string>\",\n      \"vehicle_type_name\": \"<string>\",\n      \"vehicle_type_image_url\": \"<string>\",\n      \"organization_vehicle_id\": \"<string>\",\n      \"organization_vehicle_name\": \"<string>\",\n      \"organization_vehicle_desc\": \"<string>\",\n      \"vehicle_type_max_speed\": 123,\n      \"vehicle_type_battery_capacity_wh\": 123,\n      \"vehicle_type_avg_consumption_wh_per_km\": 123,\n      \"vehicle_type_tank_capacity_l\": 123,\n      \"vehicle_type_avg_consumption_l_per_100km\": 123,\n      \"location_main_desc\": \"<string>\"\n    }\n  ],\n  \"initial_distance\": 123,\n  \"initial_operation_hours\": 123,\n  \"initial_date\": \"2023-12-25\",\n  \"initialization_complete\": true,\n  \"auto_discover_home\": true,\n  \"trips_end_at_home\": true,\n  \"remove_trip_points_on_land\": true,\n  \"vehicle_length_m\": 123,\n  \"vehicle_depth_m\": 123,\n  \"vehicle_height_m\": 123,\n  \"vehicle_weight_kg\": 123,\n  \"main_battery_property_pct\": \"<string>\",\n  \"main_fuel_property_pct\": \"<string>\",\n  \"display_settings\": {\n    \"webapp_sidebar_slot_1\": \"<string>\",\n    \"webapp_sidebar_slot_2\": \"<string>\",\n    \"nativeapp_dashboard_main\": \"<string>\",\n    \"nativeapp_four_most_important_1\": \"<string>\",\n    \"nativeapp_four_most_important_2\": \"<string>\",\n    \"nativeapp_four_most_important_3\": \"<string>\",\n    \"nativeapp_four_most_important_4\": \"<string>\"\n  }\n}"

response = http.request(request)
puts response.read_body

200

{
  "header": {
    "api_version": "<string>",
    "status": "<string>",
    "message": "<string>",
    "permission_via": [
      {
        "permission": "<string>",
        "organization_id": "<string>"
      }
    ]
  },
  "data": {
    "id": "<string>",
    "device_id": "<string>",
    "name": "<string>",
    "type": "<string>",
    "desc": "<string>",
    "image_url": "<string>",
    "delivery_date": "2023-11-07T05:31:56Z",
    "ble_temp_type": "<string>",
    "temp_1_desc": "<string>",
    "temp_2_desc": "<string>",
    "temp_3_desc": "<string>",
    "temp_4_desc": "<string>",
    "battery_main_desc": "<string>",
    "battery_ext_1_desc": "<string>",
    "device_angle_offset": 123,
    "tank_size": 123,
    "can_readout": true,
    "obd2_readout": true,
    "n2k_readout": true,
    "hibernation_mode": true,
    "maintenance_can_distance": true,
    "hardware_type": "<string>",
    "protocol_type": "<string>",
    "bluetooth": true,
    "bluetooth_address": "<string>",
    "development_vehicle": true,
    "sim_type": "<string>",
    "processing_pipeline": "<string>",
    "processing_pipeline_module_options_overrides": "<unknown>",
    "brand": "<string>",
    "description": "<string>",
    "image_id": "<string>",
    "group_id": "<string>",
    "primary_organization_id": "<string>",
    "manufacturing_organization_id": "<string>",
    "professional_vehicle_id": "<string>",
    "professional_vehicle_name": "<string>",
    "professional_location_main_lon": 123,
    "professional_location_main_lat": 123,
    "professional_location_main_desc": "<string>",
    "oem_vehicle_id": "<string>",
    "oem_vehicle_type_id": "<string>",
    "vehicle_registration_id": "<string>",
    "vehicle_identification_number": "<string>",
    "ain_1_desc": "<string>",
    "ain_2_desc": "<string>",
    "ain_3_desc": "<string>",
    "ain_4_desc": "<string>",
    "din_1_desc": "<string>",
    "din_2_desc": "<string>",
    "din_3_desc": "<string>",
    "din_4_desc": "<string>",
    "din_5_desc": "<string>",
    "dout_1_desc": "<string>",
    "dout_2_desc": "<string>",
    "dout_3_desc": "<string>",
    "dout_4_desc": "<string>",
    "battery_ext_2_desc": "<string>",
    "battery_ext_3_desc": "<string>",
    "battery_ext_4_desc": "<string>",
    "tank_prefer_analog": true,
    "transport_mode": true,
    "notrack_mode": true,
    "notrack_mode_deact_time": "2023-11-07T05:31:56Z",
    "function_control_mode_deact_time": "2023-11-07T05:31:56Z",
    "subscription": {
      "id": "<string>",
      "timestamp_start": "2023-11-07T05:31:56Z",
      "timestamp_end": "2023-11-07T05:31:56Z",
      "service_type": "BASE",
      "user_id": "<string>",
      "vehicle_id": "<string>",
      "stripe_subscription": "<string>",
      "voucher_id": 123
    },
    "organization_vehicles": [
      {
        "id": "<string>",
        "organization_id": "<string>",
        "vehicle_id": "<string>",
        "vehicle_device_id": "<string>",
        "primary_organization": true,
        "manufacturing_organization": true,
        "vehicle_category_id": "<string>",
        "vehicle_category_name": "<string>",
        "vehicle_family_id": "<string>",
        "vehicle_family_name": "<string>",
        "vehicle_type_id": "<string>",
        "vehicle_type_name": "<string>",
        "vehicle_type_image_url": "<string>",
        "organization_vehicle_id": "<string>",
        "organization_vehicle_name": "<string>",
        "organization_vehicle_desc": "<string>",
        "vehicle_type_max_speed": 123,
        "vehicle_type_battery_capacity_wh": 123,
        "vehicle_type_avg_consumption_wh_per_km": 123,
        "vehicle_type_tank_capacity_l": 123,
        "vehicle_type_avg_consumption_l_per_100km": 123,
        "location_main_desc": "<string>"
      }
    ],
    "initial_distance": 123,
    "initial_operation_hours": 123,
    "initial_date": "2023-12-25",
    "initialization_complete": true,
    "auto_discover_home": true,
    "trips_end_at_home": true,
    "remove_trip_points_on_land": true,
    "vehicle_length_m": 123,
    "vehicle_depth_m": 123,
    "vehicle_height_m": 123,
    "vehicle_weight_kg": 123,
    "main_battery_property_pct": "<string>",
    "main_fuel_property_pct": "<string>",
    "display_settings": {
      "webapp_sidebar_slot_1": "<string>",
      "webapp_sidebar_slot_2": "<string>",
      "nativeapp_dashboard_main": "<string>",
      "nativeapp_four_most_important_1": "<string>",
      "nativeapp_four_most_important_2": "<string>",
      "nativeapp_four_most_important_3": "<string>",
      "nativeapp_four_most_important_4": "<string>"
    }
  }
}

{
  "header": {
    "api_version": "<string>",
    "status": "<string>",
    "message": "<string>",
    "permission_via": [
      {
        "permission": "<string>",
        "organization_id": "<string>"
      }
    ]
  },
  "error": {
    "id": "<string>",
    "status": 123,
    "type": "<string>",
    "message": "<string>",
    "message_i18n": "<string>",
    "data": {}
  }
}

{
  "header": {
    "api_version": "<string>",
    "status": "<string>",
    "message": "<string>",
    "permission_via": [
      {
        "permission": "<string>",
        "organization_id": "<string>"
      }
    ]
  },
  "error": {
    "id": "<string>",
    "status": 123,
    "type": "<string>",
    "message": "<string>",
    "message_i18n": "<string>",
    "data": {}
  }
}

{
  "header": {
    "api_version": "<string>",
    "status": "<string>",
    "message": "<string>",
    "permission_via": [
      {
        "permission": "<string>",
        "organization_id": "<string>"
      }
    ]
  },
  "error": {
    "id": "<string>",
    "status": 123,
    "type": "<string>",
    "message": "<string>",
    "message_i18n": "<string>",
    "data": {}
  }
}

{
  "header": {
    "api_version": "<string>",
    "status": "<string>",
    "message": "<string>",
    "permission_via": [
      {
        "permission": "<string>",
        "organization_id": "<string>"
      }
    ]
  },
  "error": {
    "id": "<string>",
    "status": 123,
    "type": "<string>",
    "message": "<string>",
    "message_i18n": "<string>",
    "data": {}
  }
}

Authorizations

Authorization · string · header · required

Note that the API key has to be sent as Token 123 where 123 is the key you received after logging in or by creating on the developer dashboard.

Path Parameters

vehicle_id · string · required

ID of vehicle to update.

Body

application/json

Request body when updating a vehicle profile.

drivetrain_type · enum<string>

The drivetrain of this vehicle.

Available options: GASOLINE, DIESEL, ELECTRIC

bluetooth_address · string

The Bluetooth address of this device. This can (usually) only be set once, after which it is read-only.

name · string

The owner-given name of this vehicle.

brand · string

The brand of this vehicle.

type · string

A type description of this vehicle.

desc · string

The owner-given description of his / her vehicle. -> Deprecated as of v2.1 in favor of description.

description · string

The owner-given description of his / her vehicle.

image_id · string

The ID of the "vehicle profile" image. You can retrieve a new image identifier by POSTing a new image to /image/. Please refer to the respective section of this documentation.

primary_organization_id · string

The ID of the primary organization, if any. The primary organization is responsible for the subscriptions and payments of the vehicle.

manufacturing_organization_id · string

The ID of the manufacturing organization, if any.

professional_vehicle_id · string

An ID given by a professional organization, if any.

professional_vehicle_name · string

An vehicle name given by a professional organization, if any.

professional_location_main_lon · number

The location (longitude) of the vehicle, as specified by the professional organization.

professional_location_main_lat · number

The location (latitude) of the vehicle, as specified by the professional organization.

professional_location_main_desc · string

A description of the vehicle's location.

oem_vehicle_id · string

An ID given by an OEM. -> Deprecated as of API v2.1 in favor of vehicle_identification_number and organization_vehicles.organization_vehicle_id.

oem_vehicle_type_id · string

The vehicle type as specified by an OEM. -> Deprecated as of API v2.1 in favor of organization_vehicles.organization_vehicle_type_id.

vehicle_registration_id · string

The vehicle's official registration ID. This is usually the license plate number.

vehicle_identification_number · string

The vehicle's official identification number, abbreviated as VIN.

ain_1_type · enum<string>

Describes the type of sensor connected to the analog input 1.

Available options: NONE, FUEL, BATTERY, BATTERY_2, BATTERY_3, BATTERY_4, 220VLAND, 220VLINV, WATER, WATERINV

ain_2_type · enum<string>

Describes the type of sensor connected to the analog input 2.

Available options: NONE, FUEL, BATTERY, BATTERY_2, BATTERY_3, BATTERY_4, 220VLAND, 220VLINV, WATER, WATERINV

ain_3_type · enum<string>

Describes the type of sensor connected to the analog input 3.

Available options: NONE, FUEL, BATTERY, BATTERY_2, BATTERY_3, BATTERY_4, 220VLAND, 220VLINV, WATER, WATERINV

ain_4_type · enum<string>

Describes the type of sensor connected to the analog input 4.

Available options: NONE, FUEL, BATTERY, BATTERY_2, BATTERY_3, BATTERY_4, 220VLAND, 220VLINV, WATER, WATERINV

ain_1_desc · string

Description of what is plugged into analog input 1.

ain_2_desc · string

Description of what is plugged into analog input 2.

ain_3_desc · string

Description of what is plugged into analog input 3.

ain_4_desc · string

Description of what is plugged into analog input 4.

din_1_type · enum<string>

Describes the type of sensor connected to the digital input 1.

Available options: NONE, 220VLAND, 220VLINV, WATER, WATERINV, ARBTR, ARBTRINV

din_2_type · enum<string>

Describes the type of sensor connected to the digital input 2.

Available options: NONE, 220VLAND, 220VLINV, WATER, WATERINV, ARBTR, ARBTRINV

din_3_type · enum<string>

Describes the type of sensor connected to the digital input 3.

Available options: NONE, 220VLAND, 220VLINV, WATER, WATERINV, ARBTR, ARBTRINV

din_4_type · enum<string>

Describes the type of sensor connected to the digital input 4.

Available options: NONE, 220VLAND, 220VLINV, WATER, WATERINV, ARBTR, ARBTRINV

din_5_type · enum<string>

Describes the type of sensor connected to the digital input 5.

Available options: NONE, 220VLAND, 220VLINV, WATER, WATERINV, ARBTR, ARBTRINV

din_1_desc · string

Description of what is plugged into digital input 1.

din_2_desc · string

Description of what is plugged into digital input 2.

din_3_desc · string

Description of what is plugged into digital input 3.

din_4_desc · string

Description of what is plugged into digital input 4.

din_5_desc · string

Description of what is plugged into digital input 5.

dout_1_type · enum<string>

Describes the type of actuator connected to the digital output 1.

Available options: NONE, LOCK, NO_REFL, IN_OSZ, IN_ISZ, OSPD_SZ, IN_FRBZ, FUEL_CRT, ARBTR

dout_2_type · enum<string>

Describes the type of actuator connected to the digital output 2.

Available options: NONE, LOCK, NO_REFL, IN_OSZ, IN_ISZ, OSPD_SZ, IN_FRBZ, FUEL_CRT, ARBTR

dout_3_type · enum<string>

Describes the type of actuator connected to the digital output 3.

Available options: NONE, LOCK, NO_REFL, IN_OSZ, IN_ISZ, OSPD_SZ, IN_FRBZ, FUEL_CRT, ARBTR

dout_4_type · enum<string>

Describes the type of actuator connected to the digital output 4.

Available options: NONE, LOCK, NO_REFL, IN_OSZ, IN_ISZ, OSPD_SZ, IN_FRBZ, FUEL_CRT, ARBTR

dout_1_desc · string

Description of what is plugged into digital output 1.

dout_2_desc · string

Description of what is plugged into digital output 2.

dout_3_desc · string

Description of what is plugged into digital output 3.

dout_4_desc · string

Description of what is plugged into digital output 4.

ble_temp_type · string

Describes the number of Bluetooth temperature sensors connected. This can either be NONE or a string-encoded bit mask of the form XXXX (e.g., 1000 when the first BLE temperature sensor is connected).

temp_1_desc · string

Descriptive text of Bluetooth temperature sensor 1.

temp_2_desc · string

Descriptive text of Bluetooth temperature sensor 2.

temp_3_desc · string

Descriptive text of Bluetooth temperature sensor 3.

temp_4_desc · string

Descriptive text of Bluetooth temperature sensor 4.

battery_main_model · enum<string>

Choice of main battery model.

Available options: 12V-DEF, 24V-DEF, 24V-2x12, 24V-SLB

battery_main_desc · string

Description of main battery.

battery_ext_1_model · enum<string>

Choice of first external battery model.

Available options: 12V-DEF, 24V-DEF, 24V-2x12, 24V-SLB

battery_ext_1_desc · string

Description of first external battery.

battery_ext_2_model · enum<string>

Choice of second external battery model.

Available options: 12V-DEF, 24V-DEF, 24V-2x12, 24V-SLB

battery_ext_2_desc · string

Description of second external battery.

battery_ext_3_model · enum<string>

Choice of third external battery model.

Available options: 12V-DEF, 24V-DEF, 24V-2x12, 24V-SLB

battery_ext_3_desc · string

Description of third external battery.

battery_ext_4_model · enum<string>

Choice of fourth external battery model.

Available options: 12V-DEF, 24V-DEF, 24V-2x12, 24V-SLB

battery_ext_4_desc · string

Description of fourth external battery.

tank_size · number

The size of the primary tank (in liters).

tank_prefer_analog · boolean

If an analog tank reading should be preferred over a CAN bus reading (if available).

hibernation_mode · boolean

If the installed IoT device is in hibernation mode (where it sends less data and thus conserves energy).

transport_mode · boolean

If the installed IoT device is in transport mode (where trips are recorded, but not saved to the logbook).

notrack_mode · boolean

If the installed IoT device is in notrack mode (the sensor / location data is not processed).

subscription · Service Subscription · object

A subscription to a service within the c.technology cloud ecosystem. This could be for a single vehicle's functionality (most common use case), but also for an additional service such as the vehicle launch service.

Note that you cannot directly create service subscriptions, but have to use another endpoint to do so (Stripe for recurring payments, buy and use a voucher for one-time activations, etc.).

organization_vehicles · Organization Vehicle · object[]

The organizations that are allowed to access this vehicle. The information passed along here might differ depending on your own organizational access.

Show child attributes

initial_distance · number

The configured initial distance before the IoT device was installed.

initial_operation_hours · number

The configured operation hours before the IoT device was installed.

initial_date · string<date>

The data when the IoT device was installed.

initialization_complete · boolean

If the initialization of this vehicle is complete.

auto_discover_home · boolean

If this vehicle automatically discovers new home locations.

trips_end_at_home · boolean

If trips of this vehicle should always stop when it approaches a home location.

remove_trip_points_on_land · boolean

If trip points on land should be removed during trip processing.

boat_type · enum<string>

The type of boat, if applicable.

Available options: MOTORBOAT, SAILBOAT

vehicle_length_m · number

The length of the vehicle in meters.

vehicle_depth_m · number

The depth of the vehicle in meters.

vehicle_height_m · number

The height of the vehicle in meters.

vehicle_weight_kg · number

The weight of the vehicle in kilograms.

main_battery_property_pct · string

The vehicle status field that is considered the main battery property.

main_fuel_property_pct · string

The vehicle status field that is considered the main fuel property.

display_settings · Vehicle Display Settings · object

Various settings related to how a vehicle is displayed in the native or web app. Currently, this is not editable, but only available as part of a vehicle GET response.

Show child attributes

Response

200

application/json

Successful update of this vehicle profile.

header · API Header Single · object · required

Default header sent along with single-resource responses.

Show child attributes

data · Vehicle Profile · object · required

A vehicle's profile, containing all settings, installed sensors, vehicle information, etc.

Show child attributes