Users

POST /userspost
PUT /usersput
GET /usersget

Vehicles

/vehiclesget
/vehicles/{vehicleNumber}get
/vehiclespost
/vehicles/uploadpost
/vehicles/{vehicleNumber}patch

trailers

/trailersget
/trailers/{trailerNumber}get
/trailerspost
/trailers/uploadpost
/trailers/{trailerNumber}patch

Company Locations

POST /company-locationspost
PATCH /company-locationspatch
GET /company-locationsget
POST /customerspost

Freight Management

Shipments
Linehaul
- POST /linehaul/manifestpost
- POST /linehaul/trippost
Delivery Manifests

Manifest Commands

POST /manifests/commandspost

Return Events

GET /eventsget
GET /return-eventsget

Forms

GET /formsget
GET /forms/resultsget

Workflow APIs

Truckload Stops
Truckload Trips

Hours of Service

POST /hos/dutystatuspost
GET /hos/logs/summaryget
GET /hos/timers/snapshotget

Vehicle Locations

GET /locations/vehiclesget
GET /locations/vehicles/snapshotget

Messages

POST /messagespost
GET /messagesget

Market AppS

GET /marketapps/sessionget

MANUFACTURING

GET /smart/alarmLogget
GET /smart/batchLoggingget

Reports

reports
- GET /reports/vehicle-performanceget

Users

POST /userspost
PUT /usersput
GET /usersget

Vehicles

/vehiclesget
/vehicles/{vehicleNumber}get
/vehiclespost
/vehicles/uploadpost
/vehicles/{vehicleNumber}patch

trailers

/trailersget
/trailers/{trailerNumber}get
/trailerspost
/trailers/uploadpost
/trailers/{trailerNumber}patch

Company Locations

POST /company-locationspost
PATCH /company-locationspatch
GET /company-locationsget
POST /customerspost

Freight Management

Shipments
Linehaul
- POST /linehaul/manifestpost
- POST /linehaul/trippost
Delivery Manifests

Manifest Commands

POST /manifests/commandspost

Return Events

GET /eventsget
GET /return-eventsget

Forms

GET /formsget
GET /forms/resultsget

Workflow APIs

Truckload Stops
Truckload Trips

Hours of Service

POST /hos/dutystatuspost
GET /hos/logs/summaryget
GET /hos/timers/snapshotget

Vehicle Locations

GET /locations/vehiclesget
GET /locations/vehicles/snapshotget

Messages

POST /messagespost
GET /messagesget

Market AppS

GET /marketapps/sessionget

MANUFACTURING

GET /smart/alarmLogget
GET /smart/batchLoggingget

Reports

reports
- GET /reports/vehicle-performanceget

POST /users

post https://integrations.mavenmachines.com/users

API endpoints for interacting with user records in the Maven system.

Creates a user in the Maven system

URL Expired

The URL for this request expired after 30 days.

Body Params

middle

string

Middle name of user

driversLicense

object

required

externalUserId

string

required

Unique external identifier for user

first

string

required

First name of user

last

string

required

Last name of user

externalTerminalIds

array of strings

External terminal identifiers associated with this user. either an externalTerminalId or externalGroupId is required

externalTerminalIds

externalGroupIds

array of strings

External group identifiers associated with this user. either an externalTerminalId or externalGroupId is required

externalGroupIds

roles

array of strings

required

Required. roles assigned to this user. an invalid role will error out

roles*

userConfigurationOverrides

object

Response

Response body

object

externalUserId

string

required

Unique external identifier for user

userId

number

required

Unique identifier for user

createdOn

string

required

Timestamp of record creation in the Maven system

updatedOn

string

required

Timestamp of last record update in the Maven system

active

boolean

required

True for active drivers. false for inactive drivers

first

string

required

First name of user

middle

string

required

Middle name of user

last

string

required

Last name of user

terminals

array of objects

required

terminals*

object

externalTerminalId

string

required

External identifier for terminal

name

string

required

Name of terminal

groups

array of objects

required

groups*

object

externalGroupId

string

required

External identifier for group

name

string

required

Name of group

roles

array of strings

required

Roles assigned to this user

roles*

object

required

string

required

Email address used to log into the Maven app. May be different than portal login email.

phone

string

required

Phone number used to log into the Maven app

driversLicense

object

required

number

string

required

Driver’s license number

state

string

required

Driver’s license issuing state

AL AK AZ AR CA CO CT DC DE FL GA HI IA ID IL IN KS KY LA MA MD ME MI MN MO MS MT NC ND NE NH NJ NM NV NY OH OK OR PA RI SC SD TN TX UT VA VT WA WI WV WY AS GU MP VI AB BC MB NB NF NS NT ON PE QC SK YT AG BN BS CH CI CL CP CS DF DG GE GJ HD JA MC MR MX NA NL OA PU QE QI SI SL SO TA TB TL VC YU ZA OT

expirationDate

date

required

Driver’s license expiration date

type

string

required

Driver’s license type classification

A B C NC

endorsements

array of strings

required

Driver’s license endorsement classifications. Can be one or more of: ["H","N","P","S","T","X","HM126"]

endorsements*

endorsementExpirations

object

Optional. Allows setting the expiration dates of endorsements.

Has additional fields

restrictions

array of strings

required

Driver’s license restriction classifications. Can be one or more of: ["E","L","M","N","O","V","Z"]

restrictions*

Updated 2 months ago

PUT /users

Language

Credentials

Header


xxxxxxxxxx
12
1
curl --request POST \
2
     --url https://integrations.mavenmachines.com/users \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "driversLicense": {
8
    "state": "AL",
9
    "type": "A"
10
  }
11
}
12
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

Updated 2 months ago

PUT /users

Users
POST /userspost
PUT /usersput
GET /usersget

Vehicles
/vehiclesget
/vehicles/{vehicleNumber}get
/vehiclespost
/vehicles/uploadpost
/vehicles/{vehicleNumber}patch

trailers
/trailersget
/trailers/{trailerNumber}get
/trailerspost
/trailers/uploadpost
/trailers/{trailerNumber}patch

Company Locations
POST /company-locationspost
PATCH /company-locationspatch
GET /company-locationsget
POST /customerspost

Freight Management
Shipments
POST /shipment-locationspost
POST /shipments/bulkUpsertpost
POST /shipmentpost
POST /pickupRequests/cancelpost
POST /shipment/updateShipmentProNumberpost
Linehaul
POST /linehaul/trippost
POST /linehaul/manifestpost
Delivery Manifests
PATCH /manifests/{manifestNumber}patch
POST /manifestNumberpost
POST /manifestspost

Manifest Commands
POST /manifests/commandspost

Return Events
GET /eventsget
GET /return-eventsget

Forms
GET /formsget
GET /forms/resultsget

Workflow APIs
Truckload Stops
DELETE /truckload/stopsdelete
GET /truckload/stopsget
PATCH /truckload/trips/statuspatch
PATCH /truckload/stopspatch
PUT /truckload/stopsput
POST /truckload/stopspost
Truckload Trips
DELETE /truckload/tripsdelete
GET /truckload/tripsget
PATCH /truckload/tripspatch
PUT /truckload/tripsput
POST /truckload/tripspost

Hours of Service
POST /hos/dutystatuspost
GET /hos/logs/summaryget
GET /hos/timers/snapshotget

Vehicle Locations
GET /locations/vehiclesget
GET /locations/vehicles/snapshotget

Messages
POST /messagespost
GET /messagesget

Market AppS
GET /marketapps/sessionget

MANUFACTURING
GET /smart/alarmLogget
GET /smart/batchLoggingget

Reports
reports
GET /reports/vehicle-performanceget

Users
POST /userspost
PUT /usersput
GET /usersget

Vehicles
/vehiclesget
/vehicles/{vehicleNumber}get
/vehiclespost
/vehicles/uploadpost
/vehicles/{vehicleNumber}patch

trailers
/trailersget
/trailers/{trailerNumber}get
/trailerspost
/trailers/uploadpost
/trailers/{trailerNumber}patch

Company Locations
POST /company-locationspost
PATCH /company-locationspatch
GET /company-locationsget
POST /customerspost

Freight Management
Shipments
POST /shipment-locationspost
POST /shipments/bulkUpsertpost
POST /shipmentpost
POST /pickupRequests/cancelpost
POST /shipment/updateShipmentProNumberpost
Linehaul
POST /linehaul/trippost
POST /linehaul/manifestpost
Delivery Manifests
PATCH /manifests/{manifestNumber}patch
POST /manifestNumberpost
POST /manifestspost

Manifest Commands
POST /manifests/commandspost

Return Events
GET /eventsget
GET /return-eventsget

Forms
GET /formsget
GET /forms/resultsget

Workflow APIs
Truckload Stops
DELETE /truckload/stopsdelete
GET /truckload/stopsget
PATCH /truckload/trips/statuspatch
PATCH /truckload/stopspatch
PUT /truckload/stopsput
POST /truckload/stopspost
Truckload Trips
DELETE /truckload/tripsdelete
GET /truckload/tripsget
PATCH /truckload/tripspatch
PUT /truckload/tripsput
POST /truckload/tripspost

Hours of Service
POST /hos/dutystatuspost
GET /hos/logs/summaryget
GET /hos/timers/snapshotget

Vehicle Locations
GET /locations/vehiclesget
GET /locations/vehicles/snapshotget

Messages
POST /messagespost
GET /messagesget

Market AppS
GET /marketapps/sessionget

MANUFACTURING
GET /smart/alarmLogget
GET /smart/batchLoggingget

Reports
reports
GET /reports/vehicle-performanceget

201A successful API response for user creation