Skip to main content

Driver Upsert Many Ep

POST 
/v1/driver/upsert_many

Create/Update Driver Information

Creates a new driver record or updates an existing one based on provided identification fields. This endpoint is versatile for managing driver data, including personal, employment, and vehicle information.

Required Scopes (idi.w)

Request​

id: str | None = None
Identifier for a driver for updating an existing driver. If included, a driver will be updated instead of created.

source_id: str | None = None
Identifier from an external system if the data is received through integration.

source_system_id: str | None = None
Identifier for the source system if the data is received through integration.

name: str
Driver's full name.

username: str
Unique username assigned to the driver.

email: str | None = None
Driver's email address.

title: str | None = None
Title or position of the driver.

hire_date: datetime
The date the driver was hired.

termination_date: datetime | None = None
The date the driver was terminated, if applicable.

depot: str | None = None
Name of the depot associated with the driver.

depot_id: str | None = None
Depot identifier associated with the driver.

in_cab_trip_mode: str | None = None
Controls what visibility driver has on in cab app.

Show Supported Modes

current
Driver can only view current trip.

all
Driver can view all trips on their shift.

restricted
Driver can view all stops but not the load or drop information.

all and next
Driver can view all trips on their shift and preview next shift after completion.

in_cab_supply_option_mode: str | None = None
Controls when driver can change supply on order on in cab app.

Show Supported Modes

disabled
Driver can not change supply.

terminal
Driver can change supply while at terminal.

order_start
Driver can change supply before beginning order.

terminal_and_order_start
Driver can change supply while at terminal and before beginning order.

preferred_template: str | None = None
The preferred shift template for the driver.

shift_preference: str ('am' | 'pm')
Driver's shift preference, either 'am' or 'pm'.

shift_length_hours: float | None = None
Driver's shift preference, either 'am' or 'pm'.

tractor_number: str | None = None
The driver's assigned tractor number.

tractor_id: str | None = None
The identifier of the driver's assigned tractor.

trailer_number: str | None = None
The driver's assigned trailer number.

trailer_id: str | None = None
The identifier of the driver's assigned trailer.

carded_terminals: list(str) | None
List of carded terminals the driver has access to.

supervisor: str | None = None
The name of the driver's supervisor.

active: bool = True
Indicates whether the driver is currently active or inactive.


Response​

created: int
The number of newly created drivers.

updated: int
The number of drivers whose records have been updated.

duplicates: list
List of duplicate driver records identified during the operation.

bad: list
List of records that could not be processed due to errors.

Responses​

Successful Response

Loading...