Jump to Content
Home
Guides
Recipes
API Reference
v4
Home
API Reference
Home
mob-api-v4
Home
Guides
Recipes
API Reference
Updates a Vehicle's Fleets
Search
All
Pages
Start typing to search…
JUMP TO
MOB-API
Admin
Creates a contactless text message associated with a contract
post
Generates a Contract's Rental Agreement
post
/admin/contracts/{id}/rental_agreements
get
Returns the Status for all vehicles at a given dealership on the Dashboard tables
get
Admin login endpoint
post
Regenerate Rental Agreement
put
View Rental Agreement details
get
Agreement Toggles
Update an Agreement Toggle
put
Delete an Agreement Toggle
delete
Return the Agreement Toggles scoped to the given fleet id
get
Create a new Agreement Toggle for a given fleet
post
Update the printed order of the fleet's Agreement Toggles
put
Agreements
Get all fields that can be mapped onto an agreement
get
Get existing mappings for an agreement
get
Update mappings for an agreement
put
Performs cleanup work to transition dealership to using a provider agreement. Should be called after uploading new agreement with Salesforce.
post
Retrieve a preview of the custom-mapped agreement that will be used for the dealership.
get
Program Selector
get
Availability
Load dealership information to the Availability Service (AVL)
post
Availability 2.0
Get availability for a Fleet/Program
get
Get availability for a Fleet/Program with intervals
get
Billing
Returns the historical Pricing Settings objects associated with a fleet
get
Creates effective Pricing Setting associated with a fleet
post
Contactless
Returns Contactless Contract/Driver Information
get
Create a Signature Image for the Driver
post
Contracts
Fetch Details for a Given Contract
get
Update Details for a Given Contract
put
Get all Toggles attached to a given Contract
get
Fetch the authorization amount for a given contract
get
Get all Drivers attached to a given Contract
get
Create a Driver attached to a given Contract
post
Fetch the available adjustments for a given contract
get
Create a billing adjustment (charge or credit) for the given contract
post
Fetch the customer attached to a given Contract
get
Fetch Details for needed information to begin a given contract
get
Get the notes for a contract
get
Add a note for a contract
post
Update a note for a contract
put
Delete a note for a contract
delete
Update the payment method for the given contract
put
Fetch the payments attached to a given Contract
get
Fetch the pricing information of a given Contract
get
Generate and fetch receipt PDF for the given contract
post
Create a settlement attempt on the balance of the contract
post
Fetch the split bill associated to a given Contract
get
Creates a split bill that is associated with a given contract
post
Update the split bill associated with a given contract
put
Deletes a split bill
delete
Fetch the adjustment associated to a given contract's split bill
get
Creates an adjustment of the specified amount on a contract's split bill
post
Creates a payment for the split bill of a given contract
post
Deletes the payment of the split bill of a given contract
delete
Generate split bill PDF for the given contract
post
Fetch the available vehicle groups for a split bill
get
creates a additional payer pdf reciept.
post
Cancel the Given Contract
delete
Start the Given Contract
put
Finish the given Contract
put
Assign a Vehicle to the Given Contract
put
Unassign the vehicle currently assigned to the given contract
put
Retrieves a list of available vehicles for the given contract
get
Returns a list of available vehicles for a contract based on the provided query
get
Returns a Warranty for a Contract
get
Creates a Warranty for a Contract
post
Update the Contract's Warranty
put
Removes the Warranty from a Contract
delete
Fetch the contracts for a customer at a particular dealership
get
Fetch the Payment Methods belonging to the given Customer
get
Fetch the manifest scope (open or closed today) of contracts for a dealership
get
Query the manifest scope (open and closed today) of contracts for a dealership
get
Fetch the manifest scope of contracts for a dealership with a pickup/dropoff time of the current day
get
Fetch the fleets for a location, along with the contracts (within the given time range, all statuses) and vehicles for each
get
Creates a new signature associated with a contactless contract
post
Returns contactless contract data
get
Modify the given contract with superuser privileges
patch
Manually start the given contract with superuser privileges, overriding the start date
put
Customers
Returns a customers's profile details
get
Update a Customer's profile
put
Returns the third party verified insurance for a Customer
get
Creates the third party insurance verified account information for future lookup
post
Deletes the list of Customers associated with the id's passed in body of request.
delete
Returns the list of Customers associated with a dealership
get
Create a new customer associated with a dealership
post
Returns the list of Customers associated with a dealership based on search query
get
Get cached profile information for a customer
get
Sends an SMS to a new/existing Customer to create/update their Customer profile
post
Finds a single Customer profile based on the given token and driver's license/email info
post
Returns the Customer objects available to the authenticated user, whose names also match the query string
get
Dealerships
Open Days
Updates Dealership Open Days and Business Hours
put
Returns the Dealership objects available to the authenticated user
get
Returns the requested dealership object to the authenticated user
get
Updates the Dealership and/or its Fleets' Settings
patch
Returns the dealership address
get
Updates the dealership address
put
Returns the list of Agreements objects associated with a dealership
get
Get availability for all cars in a dealership by 30-minute interval for every interval between start and end, inclusive
get
Get availability for all cars in a dealership by day for every day between start and end, inclusive
get
Get availability from a static start time for all cars in a dealership by 30-minute interval for every interval between start and end, inclusive
get
Get availability from a static start time for all cars in a dealership by day for every day between start and end, inclusive
get
Get Dealership bookable attribute
get
Set Dealership bookable attribute to true – authorized users are controlled by a feature flag
post
Sets Dealership bookable attribute to false – authorized users are controlled by a feature flag
delete
Returns a paginated list of Reservations or Contracts for a Dealership Calendar
get
Returns a paginated list of Vehicle objects for the Calendar
get
Returns the list of Fleet objects associated with a dealership
get
Creates a new fleet associated with a dealership
post
Bulk onboarding vehicles by uploading a CSV file, and return a list of results about success/error
post
Check the status of bulk onboarding vehicles by CSV, and return a big chunk of json response of the status
get
Returns the dealership specific or default set of KPIs
post
Get Dealership Report Vehicle Inventory Data
get
Get Dealership Receivables Report Data
get
Get Dealership Receivables Report Summary
get
Get Dealership Report Revenue Data
get
Get Dealership Report Summary
get
Get Dealership Report Transactions Data
get
Get Filtered and/or Sorted Dealership Report Transactions Data
post
Returns the list of Service Advisors associated with a dealership
get
Returns the dealership settings
get
Updates the dealership's settings - Available to customer support users only.
put
Returns a paginated list of Vehicle objects associated with a dealership
get
Creates a new Vehicle for a Dealership and assigns it to a list of Fleets
post
Returns the list of Vehicle objects associated with a dealership based on search query
get
Gets all vehicles no matter the state for a dealer
get
Returns the Dealership objects available to the authenticated user, whose names also match the query string
get
Returns the user roles for a given location
get
Create a new dealership
post
Create a Reservation within a single endpoint
post
Update a Reservation within a single endpoint
put
Get the customer information for a reservation
get
Update the customer information for a reservation
put
Gets Fleets Availability and Rates
get
Get list of dealerships enrolled in insurance verification integration
get
Enroll dealership in verified insurance integration
post
Disable dealership insurance verification enrollment
put
Gets Toggles per Dealership Agreement
get
Update a dealership
put
Returns a dealership ID
get
Returns a paginated list of Parking Lot objects
get
Agreement Group List
get
Agreement Group Create
post
Agreement Group Update
put
Add a new rental agreement to a location
post
Gets the most recent rental agreement
get
Insurance Forms List
get
Agreement Group Delete
delete
Drivers
Get a Driver's details
get
Update a Driver's details
put
Delete a Driver
delete
Create a Signature Image for the Driver
post
Employees
Returns an employee's profile details
get
Update an Employee's details
put
Deactivate an Employee
delete
Activate an Employee
post
Returns an employee's roles for a dealership
get
Update an employee's roles for a dealership
put
Returns the list of Employees associated with a dealership
get
Create a new employee associated with a dealership
post
Returns the list of Employees associated with a dealership based on search query
get
Employer Info
Get a customer's employer information
get
Create a customer's employer information
post
Updates an employer for a customer
put
Fleets
Returns a given dealerships vehicle trims for all her fleets
get
Returns quantity of cars offending defleet limits
get
Gets a fleet
get
Updates a fleet
put
Deletes a fleet. NOTE: Temporarily Disabled. See SC-5730.
delete
Get active fleet size and required vehicles needed within a time range
get
Get availability by 30-minute interval for every interval between start and end, inclusive
get
Get availability by day for every day between start and end, inclusive
get
Get availability from a static time by 30-minute interval for every interval between start and end, inclusive
get
Get availability from a static time by day for every day between start and end, inclusive
get
Get Fleet bookable attribute
get
Set a fleet as bookable
post
Disables fleet as bookable
delete
Creates a new Contract associated with a Fleet
post
Creates Custom Fields associated with a Fleet
post
Creates a new Vehicle associated with a Fleet
post
Returns all the program types and the fleets associated with them
get
Fleet Settings
/admin/dealerships/{dealership_id}/fleet_settings/bulk_update
post
Gets a fleet settings instance
get
Updates a fleet settings instance
put
Gets a key value pair of program types
get
Geolocation
Returns the distance between 2 addresses and whether the distance falls inside a radial bound
post
Returns the contexts against vins that includes location, offlot radius and contract status
get
Insurance
Return the current active insurance the customer has
get
updateAdminCustomerInsurance
put
Update insurance for a customer
put
postAdminCustomerInsurance
post
Create a insurance for a customer
post
Issues
Deletes an issue
delete
Resolves an issue
put
Managed Toggles
Updates a toggle group's toggle
put
Deletes a toggle group's toggle
delete
Activate a ManagedToggle for a Dealership
post
Deactivate a ManagedToggle for a Dealership
delete
Update the printed order of the toggle group's toggles
put
Oem Infos
Retrieve Oem Info given Oem and Oem Dealer Code
get
Creates a new Oem Info
post
Update Oem Info
put
Deletes Oem Info
delete
Payment Provider Configuration
Returns the token and provider name available for the authenticated user
get
Recalls
Retrieve recalls for a specific VIN
get
Retrieve a specific recall by VIN and Recall ID
get
Triggers the import of a recall file
post
Roles
Returns the grantable roles for a given dealership
get
SCBA Booking Flow
Returns Dealerships with Address where Bookable field is True
get
Gets Dealership Availability
get
Gets Dealership Fleet Pricing
get
ScheduleNote
Create or Update a note attached to a reservation in our Schedule component
post
Settings
/admin/dealerships/{id}/fleet_settings
get
Telematics
Enroll all Vehicles in a non-disposed state for location.
post
Returns the dealership telematics settings
get
Updates a dealership's telematics settings - Available to customer support users only.
put
Returns the vehicle telematics settings
get
Sets the vehicle telematics settings for all non-embedded providers (i.e. CCDs)
put
Deletes the vehicle telematics settings
delete
Tenancy
Deletes tenancy records created during to automation testing
delete
Returns the available location ids as a string for a given tenant group
get
Returns a list of all tenant groups
get
Creates a new tenant group
post
Remove group location from group
delete
Add one or more locations to tenancy group
post
Toggle Groups
Enables managed toggles for a dealership - Available to customer support users only.
post
Updates a dealership's toggle group - Available to customer support users only.
put
Disables managed toggles for a dealership - Available to customer support users only.
delete
Get all the agreements for a location with their associated toggles
get
Returns the list of toggles from a toggle group
get
Creates a new toggle for a toggle group - Available to customer support users only.
post
Returns the requested toggle group object
get
Updates a toggle group
put
Deletes a toggle group
delete
Gets toggle groups, excluding discarded ones.
get
Creates a new toggle group (a group that manages toggles for all dealerships associated with it) - Available to customer support users only.
post
Toll Providers
Returns the requested toll provider object
get
Updates a toll provider
put
Deletes a toll provider
delete
Lists existing Toll Providers
get
Creates a new Toll Provider
post
User
Get the currently logged in user
get
Update the currently logged in user's details
put
Update the currently logged in user's password
put
Update the currently logged in user's dw-web preferences
put
Users
Create a user's password, confirm their account
post
/admin/users/password/forgot
post
Reset a users password with valid reset password token
put
Vehicles
Returns a singular Vehicle object
get
Updates a Vehicle's Fleets
put
Get all collision events for a given vehicle
get
Enroll Vehicle
post
Unenroll Vehicle
delete
Get all telematics events for a given vehicle
get
Updates a Vehicle's Fleet
put
Get all issues for a given vehicle (paginated)
get
Create new issue for the vehicle
post
Get all service warnings for a given vehicle
get
Enrollment status of vehicle
get
Fetch the last recorded telemetry for a given vehicle
get
Retrieve Vehicle Telematics Details
get
Parking Lot
Parking Lot Ingestion
post
NNA Nissan
NNA redirect
post
ManagedToggleGroups
Managed Toggle Groups Index
get
Managed Toggle Group Create
post
Managed Toggle Group Show
get
Managed Toggle Group Update
put
Managed Toggle Group Delete
delete
ManagedToggles
Managed Toggles Index
get
Managed Toggle
get
Managed Toggles Create
post
Create a insurance for a customer
post
Update insurance for a customer
put
Powered by
Updates a Vehicle's Fleets
put
https://example.com/admin/vehicles/
{id}
Language
Shell
Node
Ruby
PHP
Python
RESPONSE
Click
Try It!
to start a request and see the response here!
