Create a driver

post

https://api.samsara.com/fleet/drivers

Add a driver to the organization.

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.

To use this endpoint, select Write Drivers under the Drivers category when creating or editing an API token. Learn More.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The driver to create.

attributes

array of objects

attributes

carrierSettings

object

Carrier for a given driver. If the driver's carrier differs from the general organization's carrier settings, the override value is used. Updating this value only updates the override setting for this driver.

currentIdCardCode

string

The ID Card Code on the back of the physical card assigned to the driver. Contact Samsara if you would like to enable this feature.

eldAdverseWeatherExemptionEnabled

boolean

Flag indicating this driver may use Adverse Weather exemptions in ELD logs.

eldBigDayExemptionEnabled

boolean

Flag indicating this driver may use Big Day exemption in ELD logs.

eldDayStartHour

integer

0 indicating midnight-to-midnight ELD driving hours, 12 to indicate noon-to-noon driving hours.

eldExempt

boolean

Flag indicating this driver is exempt from the Electronic Logging Mandate.

eldExemptReason

string

Reason that this driver is exempt from the Electronic Logging Mandate (see eldExempt).

eldPcEnabled

boolean

Flag indicating this driver may select the Personal Conveyance duty status in ELD logs.

eldYmEnabled

boolean

Flag indicating this driver may select the Yard Move duty status in ELD logs.

externalIds

object

The external IDs for the given object.

hasDrivingFeaturesHidden

boolean

A boolean indicating whether the driver has driving-related features hidden in the Driver App, including Vehicle selection, HOS, Routing, Team Driving, Documents, and Trip Logs. Default value is false if omitted. Note: only available to customers of Connected Forms.

hasVehicleUnpinningEnabled

boolean

A boolean indicating whether the driver has vehicle unpinning enabled. Default value is true if omitted.

hosSetting

object

Hos settings for a driver.

licenseNumber

string

Driver's state issued license number. The combination of this number and licenseState must be unique.

licenseState

string

Abbreviation of US state, Canadian province, or US territory that issued driver's license.

locale

string

enum

Locale override (uncommon). These are specified by ISO 3166-2 country codes for supported locales. Valid values: us, at, be, ca, gb, fr, de, ie, it, lu, mx, nl, es, ch, pr.

name

string

required

length between 1 and 255

Driver's name.

notes

string

length ≤ 4096

Notes about the driver.

password

string

required

Password that the driver can use to login to the Samsara driver app.

peerGroupTagId

string

The peer group tag id this driver belong to, used for gamification.

phone

string

length ≤ 255

Phone number of the driver.

profileImageBase64

string

Base64-encoded profile image data. This field can be used to upload a profile image during driver creation. The image will be processed and stored, and the profileImageUrl will be returned in the response. If Camera ID is enabled, uploaded profile photos are used to train the model to recognize drivers automatically. You can manage this setting in Driver Assignment.

profileImageUrl

string

length ≤ 1024

URL to the driver's profile image. This field is returned in responses and can be used to set a profile image from an external URL during driver creation.

staticAssignedVehicleId

string

ID of vehicle that the driver is permanently assigned to. (uncommon).

tachographCardNumber

string

Driver's assigned tachograph card number (Europe specific)

tagIds

array of strings

IDs of tags the driver is associated with. If your access to the API is scoped by one or more tags, this field is required to pass in.

tagIds

timezone

string

Home terminal timezone, in order to indicate what time zone should be used to calculate the ELD logs. Driver timezones use IANA timezone database keys (e.g. America/Los_Angeles, America/New_York, Europe/London, etc.). You can find a mapping of common timezone formats to IANA timezone keys here.

trailerGroupTagId

string

Tag ID which determines which trailers a driver will see when selecting trailers.

usDriverRulesetOverride

object

US Driver Ruleset override for a given driver. If the driver is operating under a ruleset different from the organization default, the override is used. Updating this value only updates the override setting for this driver. Explicitly setting this field to null will delete driver's ruleset override. If the driver does not have an override ruleset set, the response will not include any usDriverRulesetOverride information.

username

string

required

length between 1 and 189

Driver's login username into the driver app. The username may not contain spaces or the '@' symbol. The username must be unique.

vehicleGroupTagId

string

Tag ID which determines which vehicles a driver will see when selecting vehicles.

waitingTimeDutyStatusEnabled

boolean

Flag indicating this driver may select waiting time duty status in ELD logs

Responses

200Newly created driver object, with Samsara-generated ID.

defaultError response