Skip to main content
PATCH
/
v2
/
fleets
/
{id}
cURL
curl --request PATCH \
  --url https://api.example.com/v2/fleets/{id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "is_active": true,
  "regions": "<string>",
  "onboarding_stage": "INITIAL",
  "client": "<string>"
}
'
{
  "id": 123,
  "region_details": [
    {
      "id": 123,
      "title": "<string>"
    }
  ],
  "title": "<string>",
  "is_active": true,
  "billing_type": "PREPAID",
  "onboarding_stage": "INITIAL",
  "warning_threshold_per_vehicle": "<string>",
  "deactivation_threshold_per_vehicle": "<string>",
  "client": "<string>",
  "onboarding_vehicle_order": 123
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
integer
required

A unique integer value identifying this Fleet.

Body

title
string
Maximum string length: 255
is_active
boolean
regions
string
customer_info
object
onboarding_stage
enum<string>
  • INITIAL - Initial
  • FLEET_NAMED - Fleet Named
  • VEHICLES_ADDED - Vehicles Added
  • COMPLETED - Completed
Available options:
INITIAL,
FLEET_NAMED,
VEHICLES_ADDED,
COMPLETED
client
string | null
Maximum string length: 100

Response

200 - application/json
id
integer
required
region_details
object[]
required
title
string
Maximum string length: 255
is_active
boolean
billing_type
enum<string>
  • PREPAID - prepaid
  • POSTPAID - postpaid
Available options:
PREPAID,
POSTPAID
onboarding_stage
enum<string>
  • INITIAL - Initial
  • FLEET_NAMED - Fleet Named
  • VEHICLES_ADDED - Vehicles Added
  • COMPLETED - Completed
Available options:
INITIAL,
FLEET_NAMED,
VEHICLES_ADDED,
COMPLETED
warning_threshold_per_vehicle
string<decimal> | null
Pattern: ^-?\d{0,5}(?:\.\d{0,2})?$
deactivation_threshold_per_vehicle
string<decimal> | null
Pattern: ^-?\d{0,5}(?:\.\d{0,2})?$
client
string | null
Maximum string length: 100
onboarding_vehicle_order
integer | null