--- title: "Create a driver" method: POST path: "/fleet/drivers" tags: ["Drivers"] --- # Create a driver `POST /fleet/drivers` ## Request - Base URL: `https://api.samsara.com` - URL: `https://api.samsara.com/fleet/drivers` - Auth: HTTP bearer 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. ## Request body - CreateDriverRequest: Driver that should be created. - `attributes` CreateDriverRequestAttributes[] - `id` string: The samsara id of the attribute object. - `name` string: Name of attribute. - `numberValues` number[]: Number values that are associated with this attribute. - `stringValues` string[]: String values that are associated with this attribute. - `carrierSettings` DriverCarrierSettings: 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. - `carrierName` string: Carrier for a given driver. - `dotNumber` integer: Carrier US DOT Number. If this differs from the general organization's settings, the override value is used. Updating this value only updates the override setting for this driver. - `homeTerminalAddress` string: Address of the place of business at which a driver ordinarily reports for work. - `homeTerminalName` string: Name of the place of business at which a driver ordinarily reports for work. - `mainOfficeAddress` string: Main office address for a given driver. If this differs from the general organization's settings, the override value is used. - `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. - `dateOfBirth` string, date: Driver's date of birth in `YYYY-MM-DD` format. Treated as a calendar date (no time component, no timezone). - `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. - `email` string, email: Driver's email address. - `externalIds` object: The [external IDs](https://developers.samsara.com/docs/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` DriverHosSetting: Hos settings for a driver. - `heavyHaulExemptionToggleEnabled` boolean: Flag indicating this driver may use the Heavy Haul exemption in ELD logs. - `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` 'us' | 'at' | 'be' | 'ca' | 'gb' | 'fr' | 'de' | 'ie' | 'it' | 'lu' | 'mx' | 'nl' | 'es' | 'ch' | 'pr': 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: Driver's name. - `notes` string: 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: 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: 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` string[]: 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. - `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](https://www.iana.org/time-zones) 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](https://unicode.org/cldr/charts/latest/supplemental/zone_tzid.html). - `trailerGroupTagId` string: Tag ID which determines which trailers a driver will see when selecting trailers. - `usDriverRulesetOverride` UsDriverRulesetOverride: 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. - `cycle` 'USA Property (8/70)' | 'USA Property (7/60)' | 'USA Passenger (8/70)' | 'USA Passenger (7/60)' | 'Alaska Property (8/80)' | 'Alaska Property (7/70)' | 'Alaska Passenger (8/80)' | 'Alaska Passenger (7/70)' | 'California School/FLV (8/80)' | 'California Farm (8/112)' | 'California Property (8/80)' | 'California Flammable Liquid (8/80)' | 'California Passenger (8/80)' | 'California Motion Picture (8/80)' | 'Florida (8/80)' | 'Florida (7/70)' | 'Nebraska (8/80)' | 'Nebraska (7/70)' | 'North Carolina (8/80)' | 'North Carolina (7/70)' | 'Oklahoma (8/70)' | 'Oklahoma (7/60)' | 'Oregon (8/80)' | 'Oregon (7/70)' | 'South Carolina (8/80)' | 'South Carolina (7/70)' | 'Texas (7/70)' | 'Wisconsin (8/80)' | 'Wisconsin (7/70)', required: The driver's working cycle. Valid values: `USA Property (8/70)`, `USA Property (7/60)`, `USA Passenger (8/70)`, `USA Passenger (7/60)`, `Alaska Property (8/80)`, `Alaska Property (7/70)`, `Alaska Passenger (8/80)`, `Alaska Passenger (7/70)`, `California School/FLV (8/80)`, `California Farm (8/112)`, `California Property (8/80)`, `California Flammable Liquid (8/80)`, `California Passenger (8/80)`, `California Motion Picture (8/80)`, `Florida (8/80)`, `Florida (7/70)`, `Nebraska (8/80)`, `Nebraska (7/70)`, `North Carolina (8/80)`, `North Carolina (7/70)`, `Oklahoma (8/70)`, `Oklahoma (7/60)`, `Oregon (8/80)`, `Oregon (7/70)`, `South Carolina (8/80)`, `South Carolina (7/70)`, `Texas (7/70)`, `Wisconsin (8/80)`, `Wisconsin (7/70)` - `restart` '34-hour Restart' | '24-hour Restart' | '36-hour Restart' | '72-hour Restart' | 'None', required: Amount of time necessary for the driver to be resting in order to restart their cycle. Valid values: `34-hour Restart`, `24-hour Restart`, `36-hour Restart`, `72-hour Restart`, `None`. - `restbreak` 'Property (off-duty/sleeper)' | 'California Mealbreak (off-duty/sleeper)' | 'None', required: The restbreak required for this driver. Valid values: `Property (off-duty/sleeper)`, `California Mealbreak (off-duty/sleeper)`, `None`. - `usStateToOverride` '' | 'AK' | 'CA' | 'FL' | 'NE' | 'NC' | 'OK' | 'OR' | 'SC' | 'TX' | 'WI', required: The jurisdiction of the ruleset applied to this driver. These are specified by either the ISO 3166-2 postal code for the supported US states, or empty string '' for US Federal Ruleset jurisdiction. Valid values: ``, `AK`, `CA`, `FL`, `NE`, `NC`, `OK`, `OR`, `SC`, `TX`, `WI`. - `username` string, required: 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 ## Response `200` Newly created driver object, with Samsara-generated ID. - DriverResponse: A single driver. - `data` Driver: A driver object - `attributes` AttributeTiny[]: A minified attribute - `dateValues` string[]: Date values that are associated with this attribute (RFC 3339 date format: YYYY-MM-DD). - `id` string: The samsara id of the attribute object. - `name` string: Name of attribute. - `numberValues` number[]: Number values that are associated with this attribute. - `stringValues` string[]: String values that are associated with this attribute. - `carrierSettings` DriverCarrierSettings: 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. - `carrierName` string: Carrier for a given driver. - `dotNumber` integer: Carrier US DOT Number. If this differs from the general organization's settings, the override value is used. Updating this value only updates the override setting for this driver. - `homeTerminalAddress` string: Address of the place of business at which a driver ordinarily reports for work. - `homeTerminalName` string: Name of the place of business at which a driver ordinarily reports for work. - `mainOfficeAddress` string: Main office address for a given driver. If this differs from the general organization's settings, the override value is used. - `createdAtTime` string: The date and time this driver was created in RFC 3339 format. - `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. - `dateOfBirth` string, date: Driver's date of birth in `YYYY-MM-DD` format. Treated as a calendar date (no time component, no timezone). - `driverActivationStatus` 'active' | 'deactivated': A value indicating whether the driver is active or deactivated. Valid values: `active`, `deactivated`. - `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. - `eldSettings` DriverEldSettings: The driver's ELD settings. - `rulesets` DriverEldRuleset[]: The driver's ELD rulesets and overrides. This is the full set of rulesets that may apply to the driver depending on their activity. If you wish to interface with the specific US driver override, use the usDriverRulesetOverride field. - `break` 'Property (off-duty/sleeper)' | 'Explosives/HazMat (on-duty)': The rest break required setting of the ELD ruleset applied to this driver. Valid values: `Property (off-duty/sleeper)`, `Explosives/HazMat (on-duty)` - `cycle` 'USA 60 hour / 7 day' | 'USA 70 hour / 8 day' | 'AK 80 hour / 8 day' | 'AK 70 hour / 7 day' | 'CA 80 hour / 8 day' | 'CA 112 hour / 8 day' | 'FL 80 hour / 8 day' | 'FL 70 hour / 7 day' | 'NE 80 hour / 8 day' | 'NE 70 hour / 7 day' | 'NC 80 hour / 8 day' | 'NC 70 hour / 7 day' | 'OK 70 hour / 8 day' | 'OK 60 hour / 7 day' | 'OR 80 hour / 8 day' | 'OR 70 hour / 7 day' | 'SC 80 hour / 8 day' | 'SC 70 hour / 7 day' | 'TX 70 hour / 7 day' | 'WI 80 hour / 8 day' | 'WI 70 hour / 7 day' | 'Canada South Cycle 1 (70 hour / 7 day)' | 'Canada South Cycle 2 (120 hour / 14 day)' | 'Canada North Cycle 1 (80 hour / 7 day)' | 'Canada North Cycle 2 (120 hour / 14 day)': The cycle of the ELD ruleset applied to this driver. Valid values: `USA 60 hour / 7 day`, `USA 70 hour / 8 day`, `AK 80 hour / 8 day`, `AK 70 hour / 7 day`, `CA 80 hour / 8 day`, `CA 112 hour / 8 day`, `FL 80 hour / 8 day`, `FL 70 hour / 7 day`, `NE 80 hour / 8 day`, `NE 70 hour / 7 day`, `NC 80 hour / 8 day`, `NC 70 hour / 7 day`, `OK 70 hour / 8 day`, `OK 60 hour / 7 day`, `OR 80 hour / 8 day`, `OR 70 hour / 7 day`, `SC 80 hour / 8 day`, `SC 70 hour / 7 day`, `TX 70 hour / 7 day`, `WI 80 hour / 8 day`, `WI 70 hour / 7 day`, `Canada South Cycle 1 (70 hour / 7 day)`, `Canada South Cycle 2 (120 hour / 14 day)`, `Canada North Cycle 1 (80 hour / 7 day)`, `Canada North Cycle 2 (120 hour / 14 day)`. - `jurisdiction` string: The jurisdiction of the ELD ruleset applied to this driver. These are specified by either `CS` or `CN` for Canada South and Canada North, respectively, or the ISO 3166-2 postal code for the supported state or territory. - `restart` 'None' | '34-hour Restart' | '24-hour Restart' | '36-hour Restart' | '72-hour Restart': The restart of the ELD ruleset applied to this driver. Valid values: `None`, `34-hour Restart`, `24-hour Restart`, `36-hour Restart`, `72-hour Restart`. - `shift` 'US Interstate Property' | 'US Interstate Passenger' | 'Texas Intrastate': The shift of the ELD ruleset applied to this driver. Valid values: `US Interstate Property`, `US Interstate Passenger`, `Texas Intrastate`. - `eldYmEnabled` boolean: Flag indicating this driver may select the Yard Move duty status in ELD logs. - `email` string, email: Driver's email address. - `externalIds` DriverExternalIds: The [external IDs](https://developers.samsara.com/docs/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. - `id` string: Samsara ID for the driver. - `isDeactivated` boolean: [DEPRECATED] A boolean indicating whether or not the driver is deactivated. Use `driverActivationStatus` instead. - `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` 'us' | 'at' | 'be' | 'ca' | 'gb' | 'fr' | 'de' | 'ie' | 'it' | 'lu' | 'mx' | 'nl' | 'es' | 'ch' | 'pr': 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: Driver's name. - `notes` string: Notes about the driver. - `peerGroupTag` TagTinyResponse: A minified tag object - `id` string: ID of the tag. - `name` string: Name of the tag. - `parentTagId` string: If this tag is part a hierarchical tag tree, this is the ID of the parent tag, otherwise this will be omitted. - `phone` string: Phone number of the driver. - `profileImageUrl` string: 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. - `staticAssignedVehicle` DriverStaticAssignedVehicle: Vehicle assigned to the driver for static vehicle assignments. (uncommon). - `id` string: ID of the vehicle. - `name` string: Name of the vehicle. - `tachographCardNumber` string: Driver's assigned tachograph card number (Europe specific) - `tags` TagTinyResponse[]: The tags this driver belongs to. - `id` string: ID of the tag. - `name` string: Name of the tag. - `parentTagId` string: If this tag is part a hierarchical tag tree, this is the ID of the parent tag, otherwise this will be omitted. - `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](https://www.iana.org/time-zones) 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](https://unicode.org/cldr/charts/latest/supplemental/zone_tzid.html). - `trailerGroupTag` DriverTrailerGroupTag: Tag which determines which trailers a driver will see when selecting trailers. - `id` string: ID of the tag. - `name` string: Name of the tag. - `parentTagId` string: If this tag is part a hierarchical tag tree, this is the ID of the parent tag, otherwise this will be omitted. - `updatedAtTime` string: The date and time this driver was last updated in RFC 3339 format. - `usDriverRulesetOverride` UsDriverRulesetOverride: 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. - `cycle` 'USA Property (8/70)' | 'USA Property (7/60)' | 'USA Passenger (8/70)' | 'USA Passenger (7/60)' | 'Alaska Property (8/80)' | 'Alaska Property (7/70)' | 'Alaska Passenger (8/80)' | 'Alaska Passenger (7/70)' | 'California School/FLV (8/80)' | 'California Farm (8/112)' | 'California Property (8/80)' | 'California Flammable Liquid (8/80)' | 'California Passenger (8/80)' | 'California Motion Picture (8/80)' | 'Florida (8/80)' | 'Florida (7/70)' | 'Nebraska (8/80)' | 'Nebraska (7/70)' | 'North Carolina (8/80)' | 'North Carolina (7/70)' | 'Oklahoma (8/70)' | 'Oklahoma (7/60)' | 'Oregon (8/80)' | 'Oregon (7/70)' | 'South Carolina (8/80)' | 'South Carolina (7/70)' | 'Texas (7/70)' | 'Wisconsin (8/80)' | 'Wisconsin (7/70)', required: The driver's working cycle. Valid values: `USA Property (8/70)`, `USA Property (7/60)`, `USA Passenger (8/70)`, `USA Passenger (7/60)`, `Alaska Property (8/80)`, `Alaska Property (7/70)`, `Alaska Passenger (8/80)`, `Alaska Passenger (7/70)`, `California School/FLV (8/80)`, `California Farm (8/112)`, `California Property (8/80)`, `California Flammable Liquid (8/80)`, `California Passenger (8/80)`, `California Motion Picture (8/80)`, `Florida (8/80)`, `Florida (7/70)`, `Nebraska (8/80)`, `Nebraska (7/70)`, `North Carolina (8/80)`, `North Carolina (7/70)`, `Oklahoma (8/70)`, `Oklahoma (7/60)`, `Oregon (8/80)`, `Oregon (7/70)`, `South Carolina (8/80)`, `South Carolina (7/70)`, `Texas (7/70)`, `Wisconsin (8/80)`, `Wisconsin (7/70)` - `restart` '34-hour Restart' | '24-hour Restart' | '36-hour Restart' | '72-hour Restart' | 'None', required: Amount of time necessary for the driver to be resting in order to restart their cycle. Valid values: `34-hour Restart`, `24-hour Restart`, `36-hour Restart`, `72-hour Restart`, `None`. - `restbreak` 'Property (off-duty/sleeper)' | 'California Mealbreak (off-duty/sleeper)' | 'None', required: The restbreak required for this driver. Valid values: `Property (off-duty/sleeper)`, `California Mealbreak (off-duty/sleeper)`, `None`. - `usStateToOverride` '' | 'AK' | 'CA' | 'FL' | 'NE' | 'NC' | 'OK' | 'OR' | 'SC' | 'TX' | 'WI', required: The jurisdiction of the ruleset applied to this driver. These are specified by either the ISO 3166-2 postal code for the supported US states, or empty string '' for US Federal Ruleset jurisdiction. Valid values: ``, `AK`, `CA`, `FL`, `NE`, `NC`, `OK`, `OR`, `SC`, `TX`, `WI`. - `username` string: Driver's login username into the driver app. The username may not contain spaces or the '@' symbol. The username must be unique. - `vehicleGroupTag` DriverVehicleGroupTag: Tag which determines which vehicles a driver will see when selecting vehicles. - `id` string: ID of the tag. - `name` string: Name of the tag. - `parentTagId` string: If this tag is part a hierarchical tag tree, this is the ID of the parent tag, otherwise this will be omitted. - `waitingTimeDutyStatusEnabled` boolean: Flag indicating this driver may select waiting time duty status in ELD logs. ## Other responses - `default`: Error response --- [API](https://skmtc.dev/samsara/apis/samsara-api.md) - [All operations](https://skmtc.dev/samsara/apis/samsara-api/llms.txt) - [OpenAPI document](https://skmtc.dev/samsara/apis/samsara-api/revisions/a9e35d4999be?raw)