Skip to main content

PatchDriverDTO

email object
anyOf
string
badge_ids object
anyOf
  • Array [
  • string
  • ]
  • site_ids object
    anyOf
  • Array [
  • string
  • ]
  • email_notifications_enabled object
    anyOf
    boolean
    profile object

    Replace the complete charging profile schedule. Include default, timezone and all exceptions you want to retain. Omitted exceptions become an empty map. Nested fields are not merged. Omitting profile or sending null leaves the existing profile unchanged; null does not delete it. Charging preferences are validated against the driver's car when available.

    anyOf
    default objectrequired

    Charging profile used on weekdays without an exception.

    ac object

    Defaults applied to AC charging sessions.

    anyOf
    expected_arrival_time objectrequired

    Expected arrival time at the charging location

    anyOf
    string
    requested_min_energyRequested Min Energy (integer)required

    Requested minimum energy in Wh

    requested_max_energyRequested Max Energy (integer)required

    Requested maximum energy in Wh

    estimated_departure_timestring<time>required
    dc object

    Defaults applied to DC charging sessions.

    anyOf
    expected_arrival_time objectrequired

    Expected arrival time at the charging location

    anyOf
    string
    requested_min_state_of_chargeRequested Min State Of Charge (number)required

    Requested minimum state of charge in percentage

    Possible values: >= 0 and <= 100

    requested_max_state_of_chargeRequested Max State Of Charge (number)required

    Requested maximum state of charge in percentage

    Possible values: >= 0 and <= 100

    estimated_departure_timestring<time>required
    exceptions object

    Weekday overrides, keyed by Monday, Tuesday, Wednesday, Thursday, Friday, Saturday or Sunday (case-sensitive), not by site ID. Each override replaces the entire default profile for that day; fields are not merged. Profiles apply to the driver across all linked sites.

    property name* DriverProfile
    ac object

    Defaults applied to AC charging sessions.

    anyOf
    expected_arrival_time objectrequired

    Expected arrival time at the charging location

    anyOf
    string
    requested_min_energyRequested Min Energy (integer)required

    Requested minimum energy in Wh

    requested_max_energyRequested Max Energy (integer)required

    Requested maximum energy in Wh

    estimated_departure_timestring<time>required
    dc object

    Defaults applied to DC charging sessions.

    anyOf
    expected_arrival_time objectrequired

    Expected arrival time at the charging location

    anyOf
    string
    requested_min_state_of_chargeRequested Min State Of Charge (number)required

    Requested minimum state of charge in percentage

    Possible values: >= 0 and <= 100

    requested_max_state_of_chargeRequested Max State Of Charge (number)required

    Requested maximum state of charge in percentage

    Possible values: >= 0 and <= 100

    estimated_departure_timestring<time>required
    timezoneTimezone (string)required

    Timezone used to interpret weekdays and profile times, e.g. Europe/Brussels.

    PatchDriverDTO
    {
    "email": "user@example.com",
    "badge_ids": [
    "string"
    ],
    "site_ids": [
    "string"
    ],
    "email_notifications_enabled": true,
    "profile": {
    "default": {
    "ac": {
    "estimated_departure_time": "17:00:00",
    "expected_arrival_time": "08:00:00",
    "requested_max_energy": 20000,
    "requested_min_energy": 5000
    }
    },
    "exceptions": {
    "Friday": {
    "ac": {
    "estimated_departure_time": "12:00:00",
    "expected_arrival_time": "08:00:00",
    "requested_max_energy": 10000,
    "requested_min_energy": 5000
    }
    }
    },
    "timezone": "Europe/Brussels"
    }
    }