v1

latestOpenAPI 3.1.02026-07-2617501.1 MB

Create a new user

post/v1/users

Headers

X-Time-Zonestring

X-Time-Zone

X-Metric-Unitsboolean

Specify if you want to use the Metric units or the Imperial units. TRUE: Metric units. FALSE: Imperial Units

X-User-Idinteger

Specify the ID of the Fleet Admin or the Fleet Manager who is accessing this endpoint.

Request body

first_namestring required

Enter the first name of the user.

last_namestring required

Enter the last name of the user.

emailstring required

Specify the email address of the user.

usernamestring required

Enter the user name of the user that you are creating.

passwordstring required

Specify a password for the user.

rolestring required

Specify the role of the user. Possible values are driver, fleet_user, or admin.

phonestring

Enter the phone number of the user.

phone_country_codestring required

Specify the user's phone country code. For example if you are creating a user in the USA, enter the country code as +1

phone_extstring

Enter the phone number extension if available.

driver_company_idstring

Enter the driver's company ID.

time_zonestring

Specify the time zone of the the user's home terminal.

group_visibilitystring

Mention the data visibility for the fleet users. Allowed values are all or limited. NOTE: This parameter is only applicable to users with the role "fleet_user".

carrier_namestring

Enter the name of the carrier you want to associate the user with.

carrier_streetstring

Enter the street address of the carrier.

carrier_citystring

Enter the city of the carrier.

carrier_statestring

Enter the state of the carrier.

carrier_zipstring

Enter the ZIP code of the carrier.

violation_alertsstring

Specify the frequency of the violation alerts that you want the Motive Mobile app to show to your drivers. Allowed values are 15_minutes, 30_minutes, 45_minutes, or 1_hour.

terminal_streetstring

Enter the street address of the terminal.

terminal_citystring

Specify the city of the terminal.

terminal_statestring

Specify the state when the terminal is located at.

terminal_zipstring

Specify the ZIP code where the terminal is located at.

cyclestring

Sets the user’s primary HOS cycle. Use one of the supported cycle codes mentioned above in a tabular format (Allowed Cycle Values). Each value maps to a specific Hours of Service rule set, such as U.S. property, oil and gas, passenger, California, Texas, Alaska, or Canadian cycle rules.

exception_24_hour_restartboolean

Set true when driver is using 24 hours restart exception for cycle.

exception_8_hour_breakboolean

Set true when driver is using 8 hour break exception for cycle.

exception_wait_timeboolean

Set true when driver is using wait time exception for cycle.

exception_short_haulboolean

Set true when driver is using short haul exception for cycle.

exception_ca_farm_school_busboolean

Set true when driver is using CA farm/school bus exception for cycle.

exception_adverse_drivingboolean

Set true when driver is allowed to extend duty day by up to 2 hours when adverse driving conditions are encountered

export_combinedboolean

Set true to export logs and DVIRs on the same page.

export_recapboolean

Set true to export recap with logs.

export_odometersboolean

Set true to export odometers with logs.

metric_unitsboolean

Set true to use metric units.

minute_logsboolean

Set true to use minute resolution log events.

eld_modestring required

Specify the mode of the vehicle gateway. Allowed values are none, logs, and exempt.

drivers_license_numberstring

Specify the license number of the driver. NOTE: This is mandatory only if the eld_mode is "logs".

drivers_license_statestring

Specify the issuing state of the driver's license. NOTE: This is mandatory only if the eld_mode is "logs".

yard_moves_enabledboolean

Set true if yard moves are allowed for the driver.

personal_conveyance_enabledboolean

Set true if personal conveyance is allowed for the driver.

statusstring

Specify the status of the user. Allowed values are active or pending.

cycle2string

Driver's secondary cycle. Valid values include 70_8, 60_7, 70_8_o, 60_7_o, 70_8_p, 60_7_p, 80_8, 80_8_o, 80_8_p, tx_70_7, ak_70_7, ak_80_8, ak_70_7_o, ak_80_8_o, ak_70_7_p, ak_80_8_p, 70_7, 120_14, canada_oil, 80_7, 120_14_north, and Other.

exception_24_hour_restart2boolean

Set true when driver is using 24 hours restart exception for secondary cycle.

exception_8_hour_break2boolean

Set true when driver is using 8 hour break exception for secondary cycle.

exception_wait_time2boolean

Set true when driver is using wait time exception for secondary cycle.

exception_short_haul2boolean

Set true when driver is using short haul exception for secondary cycle.

exception_ca_farm_school_bus2boolean

Set true when driver is using CA farm/school bus exception for secondary cycle.

exception_adverse_driving2boolean

Set true when driver is allowed to extend duty day by up to 2 hours when adverse driving conditions are encountered

manual_driving_enabledboolean

Set true when driver is allowed to manually add driving time

dot_idstring

Driver's DOT number. NOTE: This is mandatory only if the eld_mode is "logs".

company_reference_idstring

Internal reference id of a user in the company

time_tracking_modestring

Specify the time tracking mode of the driver. Allowed values are logs, timecards, & not_required.

Response

200

Example response

{
  "user": {
    "id": 5397423,
    "first_name": "John",
    "last_name": "Doe",
    "company_reference_id": "1a",
    "carrier_name": "KT Test Carrier",
    "violation_alerts": "1_hour",
    "export_combined": true,
    "export_recap": true,
    "export_odometers": true,
    "username": "john.doe.demo.fleet",
    "duty_status": "off_duty",
    "eld_mode": "none",
    "time_tracking_mode": "logs",
    "company_connection": {
      "id": 4698551,
      "role": "driver",
      "status": "active"
    },
    "role": "driver",
    "status": "active",
    "created_at": "2025-02-05T19:30:04Z",
    "updated_at": "2025-02-05T19:30:04.209050Z"
  }
}