Skip to main content
POST
/
drivers
/
{driver}
Update a driver
curl --request POST \
  --url https://api.chargeapi.co/v1/drivers/{driver} \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "email": "<string>",
  "phone": "<string>",
  "license_number": "<string>",
  "status": "active",
  "preferences": {
    "charging_speed": null,
    "currency": null,
    "default_payment_method": null,
    "max_price_per_kwh": null,
    "notifications": null,
    "preferred_charging_stations": null,
    "preferred_cpos": null
  },
  "metadata": {}
}'
{
  "id": null,
  "object": null,
  "created": null,
  "email": null,
  "fleets": null,
  "license_number": null,
  "name": null,
  "phone": null,
  "preferences": {
    "charging_speed": null,
    "currency": null,
    "default_payment_method": null,
    "max_price_per_kwh": null,
    "notifications": null,
    "preferred_charging_stations": null,
    "preferred_cpos": null
  },
  "status": null,
  "updated": null,
  "vehicles": null,
  "wallet_balance": null
}

Path Parameters

​
driver
string
required

ID of the driver to update.

Body

application/json
​
name
string

Updated full name.

​
email
string

Updated contact email.

​
phone
string

Updated phone number.

​
license_number
string

Driver’s license number to store or update.

​
status
enum<string>

Set driver status.

Available options:
active,
suspended,
archived
​
preferences
any
​
metadata
object

Merge or replace custom key-value metadata pairs.

Response

Returns the updated Driver object with all requested changes applied..

​
id
string

Unique identifier for the driver object.

Example:

null

​
object
string

String representing the object’s type. Always driver.

Example:

null

​
created
integer

Time at which the driver was created (UNIX timestamp).

Example:

null

​
email
string

Email address used for login and notifications.

Example:

null

​
fleets
string[]

List of fleet IDs currently linked to the driver.

Example:

null

​
license_number
string | null

Driver’s license number, if applicable.

Example:

null

​
name
string

Full name of the driver.

Example:

null

​
phone
string | null

Optional phone number for communication and account recovery.

Example:

null

​
preferences
object

Driver’s personal preferences for charging experience and routing.

​
status
enum<string>

Current status of the driver account.

Available options:
active,
suspended,
archived
Example:

null

​
updated
integer

Time at which the driver object was last updated.

Example:

null

​
vehicles
string[]

List of vehicle IDs currently linked to the driver.

Example:

null

​
wallet_balance
integer

Driver’s wallet or prepaid balance in the smallest currency unit (e.g., cents).

Example:

null