openapi: 3.2.0 info: contact: email: support@dealerware.com name: Dealerware Support url: https://support.dealerware.com description: MOB-API termsOfService: support@dealerware.com title: MOB Fleet Settings API version: 1.0.0 servers: - url: https://api.dealerware.com description: Production server - url: https://api.dw-tst.com description: Staging server security: - Auth0: [] tags: - name: Fleet Settings paths: /admin/dealerships/{dealership_id}/fleet_settings/{id}: parameters: - name: api-version in: header description: Target API version required: true schema: type: integer example: 4 get: summary: Returns Fleet Settings for a Vehicle Group operationId: getVehicleGroupDeFleetSettings tags: - Fleet Settings parameters: - name: dealership_id in: path required: true description: the dealership ID schema: type: integer - name: id in: path required: true description: the fleet ID schema: type: integer responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/AdminDealershipFleetSettingsResponse' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '406': $ref: '#/components/responses/NotAcceptable' /admin/dealerships/{id}: parameters: - name: api-version in: header description: Target API version required: true schema: type: integer example: 4 patch: summary: Updates the Dealership and/or its Fleets' Settings operationId: patchDealershipAndFleetSettings tags: - Fleet Settings parameters: - name: id in: path required: true description: numeric id of the requested dealership schema: type: integer requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateAdminDealershipRequest' responses: '204': $ref: '#/components/responses/NoContent' '401': $ref: '#/components/responses/Unauthorized' '422': $ref: '#/components/responses/UnprocessableEntity' /admin/fleets/{id}/settings: parameters: - name: api-version in: header description: Target API version required: true schema: type: integer example: 4 get: summary: Gets a fleet settings instance operationId: getFleetSettings tags: - Fleet Settings parameters: - name: id in: path required: true description: The id of the fleet schema: type: integer responses: '200': description: Success content: application/json: schema: type: object $ref: '#/components/schemas/AdminFleetSettingsResponse' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '406': $ref: '#/components/responses/NotAcceptable' put: summary: Updates a fleet settings instance operationId: putFleetSettings tags: - Fleet Settings parameters: - name: id in: path required: true description: The id of the fleet schema: type: integer requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AdminFleetSettingsRequest' responses: '204': $ref: '#/components/responses/NoContent' '401': $ref: '#/components/responses/Unauthorized' '403': $ref: '#/components/responses/Forbidden' '404': $ref: '#/components/responses/NotFound' '406': $ref: '#/components/responses/NotAcceptable' '422': $ref: '#/components/responses/UnprocessableEntity' components: schemas: AdminFleetSettingsGeofencePenaltyCharge: type: object required: - price - taxable - customer_sms - auto_charge additionalProperties: false properties: price: type: number format: float example: 500 taxable: type: boolean example: false customer_sms: type: boolean example: false auto_charge: type: boolean example: false AdminFleetSettingsGeofenceCharge: type: object required: - name - enabled_for_rented_vehicles - vehicle_exits additionalProperties: false properties: name: type: string example: North Lot description: 'Fence display name. This is owned by geofence configuration events and is preserved during settings updates when the fence already exists in mob-api. ' enabled_for_rented_vehicles: type: boolean example: true description: 'Whether the fence applies to rented vehicles. This is owned by geofence configuration events and is preserved during settings updates when the fence already exists in mob-api. ' vehicle_exits: type: boolean example: true description: 'Whether this fence charges when the vehicle exits the geofence. This is owned by geofence configuration events and is preserved during settings updates when the fence already exists in mob-api. ' penalty: type: - object - 'null' allOf: - $ref: '#/components/schemas/AdminFleetSettingsGeofencePenaltyCharge' description: Optional charge configuration. Omitted, null, or a valid charge object are accepted. AdminDealershipFleetSettingsResponse: type: object required: - id - name - agreement_id - program_type - repair_order_number_required - reservation_time_cap - reservation_time_cap_warning - rented_vehicle_buffer_minutes - require_customer_vin - guided_walkaround_enforced - sales_lead_enabled - sales_lead_offset_hours - sales_lead_cms_config_email - misc properties: id: type: integer example: 150494 name: type: string example: Courtesy Group agreement_id: type: - integer - 'null' example: 150494 program_type: type: - string - 'null' example: Courtesy repair_order_number_required: type: boolean example: true reservation_time_cap: type: - integer - 'null' example: 24 reservation_time_cap_warning: type: - integer - 'null' example: 12 rented_vehicle_buffer_minutes: type: - integer - 'null' example: 20 require_customer_vin: type: boolean example: false guided_walkaround_enforced: type: boolean example: false sales_lead_enabled: type: boolean example: false description: whether Service to Sales lead generation is enabled for the fleet sales_lead_offset_hours: type: integer example: 3 description: how many hours prior to a contract end a sales lead should be created (1-12) sales_lead_cms_config_email: type: - string - 'null' example: leads@dealer.com description: email address the Service to Sales lead configuration should notify in ADF format misc: type: object additionalProperties: true example: defleet_settings: null AdminFleetSettingsResponse: type: object properties: dealer_code: type: string example: DLW123AD default_infleet_group: type: boolean example: true drive_protection: $ref: '#/components/schemas/AdminFleetSettingsDriveProtection' external_availability_group: type: boolean example: false exclude_rate: type: boolean example: false availability: type: object example: '{ "grouping": "make,model,trim" }' description: An object of availability settings properties: grouping: type: string example: make,model,trim description: 'A comma delimited list of trim properties on which to to group vehicles (make, model, trim, body_type, power_train) ' fleet_id: type: integer example: 123 geofence_charges: $ref: '#/components/schemas/AdminFleetSettingsGeofenceCharges' minimum_age: type: integer example: 21 program_type: type: string example: rental description: A string representing the type of program the fleet is in (courtesy, rental, etc) view_vehicles_under_contract: type: boolean example: true require_insurance_sufficiency: type: string enum: - none - loaner - rental - loaner_rental example: loaner_rental description: Specifies when insurance sufficiency checks are required (none, loaner, rental, or loaner_rental) rented_vehicle_buffer_minutes: type: - integer - 'null' example: 20 sales_lead_enabled: type: boolean example: false description: whether Service to Sales lead generation is enabled for the fleet sales_lead_offset_hours: type: integer example: 3 description: how many hours prior to a contract end a sales lead should be created (1-12) sales_lead_cms_config_email: type: - string - 'null' example: leads@dealer.com description: email address the Service to Sales lead configuration should notify in ADF format AdminFleetSettingsDriveProtection: type: object required: - taxable additionalProperties: false properties: collision_damage_warranty: type: boolean example: false description: Legacy CDW setting. It must remain disabled. loss_damage_warranty: type: boolean example: true renters_contingent_liability_insurance: type: boolean example: false supplemental_liability_insurance: type: boolean example: true taxable: type: boolean example: true AdminFleetSettingsRequest: type: object properties: dealer_code: type: string example: DLW123AD default_infleet_group: type: boolean example: true drive_protection: $ref: '#/components/schemas/AdminFleetSettingsDriveProtection' external_availability_group: type: boolean example: false exclude_rate: type: boolean example: false minimum_age: type: integer example: 21 geofence_charges: $ref: '#/components/schemas/AdminFleetSettingsGeofenceCharges' program_type: type: string example: rental view_vehicles_under_contract: type: boolean example: true require_insurance_sufficiency: type: string enum: - none - loaner - rental - loaner_rental example: loaner_rental description: Specifies when insurance sufficiency checks are required (none, loaner, rental, or loaner_rental) rented_vehicle_buffer_minutes: type: - integer - 'null' example: 20 AdminFleetSettingsGeofenceCharges: type: object description: Geofence charge settings keyed by geofence id. additionalProperties: $ref: '#/components/schemas/AdminFleetSettingsGeofenceCharge' example: fence-123: name: North Lot enabled_for_rented_vehicles: true vehicle_exits: true fence-456: name: Service Boundary enabled_for_rented_vehicles: true vehicle_exits: true penalty: price: 500 taxable: false customer_sms: false auto_charge: false UpdateAdminDealershipRequest: type: object properties: email: type: string example: john.doe@silvercar.com name: type: string example: Dealership 1 onboarding_complete: type: boolean example: false phone_number: type: string example: (555) 123-4567 fleet_settings: type: array items: type: object properties: fleet_id: type: integer example: 123 repair_order_number_required: type: boolean example: false allow_charge_later: type: boolean example: true allow_manual_signature: type: boolean example: false require_customer_vin: type: boolean example: false guided_walkaround_enforced: type: boolean example: false sales_lead_enabled: type: boolean example: true description: whether Service to Sales lead generation is enabled for the fleet sales_lead_offset_hours: type: integer example: 3 description: how many hours prior to a contract end a sales lead should be created (1-12) sales_lead_cms_config_email: type: - string - 'null' example: leads@dealer.com description: email address the Service to Sales lead configuration should notify in ADF format. responses: NoContent: description: No Content UnprocessableEntity: description: Unprocessable Content content: application/json: schema: type: object properties: message: type: string example: Invalid resource id code: type: integer example: 6789 NotFound: description: Not found content: application/json: schema: type: object properties: message: type: string example: Resource with id :id not found code: type: integer example: 6789 Unauthorized: description: Unauthorized content: application/json: schema: type: object properties: message: type: string example: Invalid authorization token code: type: integer example: 6789 NotAcceptable: description: Not Acceptable content: application/json: schema: type: object properties: message: type: string example: Missing headers in request code: type: integer example: 6789 Forbidden: description: Forbidden content: application/json: schema: type: object properties: message: type: string example: Request is forbidden code: type: integer example: 6789 securitySchemes: Auth0: type: oauth2 flows: clientCredentials: tokenUrl: https://dealerware.auth0.com/oauth/token scopes: {} x-provenance: method: searched source: https://developer.dealerware.com/reference harvested: '2026-10-14' tool: harvest-readme-openapi.py note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored. assembled_from: - https://developer.dealerware.com/reference/admincustomerget-1.md - https://developer.dealerware.com/reference/createblacklist-1.md - https://developer.dealerware.com/reference/deleteadmincontractcancel-1.md - https://developer.dealerware.com/reference/deleteadmincontractsplitbill-1.md - https://developer.dealerware.com/reference/deleteadmincontractsplitbillpayment-1.md - https://developer.dealerware.com/reference/deleteadmincontractswarranty-1.md - https://developer.dealerware.com/reference/deleteadmindealershipwebhook.md - https://developer.dealerware.com/reference/deleteadmindriver-1.md - https://developer.dealerware.com/reference/deletecontractnote-1.md - https://developer.dealerware.com/reference/deletecustomerfromblacklist-1.md - https://developer.dealerware.com/reference/deletedealershipcustomernotes.md - https://developer.dealerware.com/reference/deletedealershipcustomers-1.md - https://developer.dealerware.com/reference/deleteemployeeactivation-1.md - https://developer.dealerware.com/reference/deletefleet-1.md - https://developer.dealerware.com/reference/deleteissue-1.md - https://developer.dealerware.com/reference/getadmincontractadjustments-1.md - https://developer.dealerware.com/reference/getadmincontractauthorization-1.md - https://developer.dealerware.com/reference/getadmincontractcustomer-1.md - https://developer.dealerware.com/reference/getadmincontractpayments-1.md - https://developer.dealerware.com/reference/getadmincontractpricing-1.md - https://developer.dealerware.com/reference/getadmincontractsdrivers-1.md - https://developer.dealerware.com/reference/getadmincontractsplitbill-1.md - https://developer.dealerware.com/reference/getadmincontractsplitbilladjustment-1.md - https://developer.dealerware.com/reference/getadmincontractstoggles-1.md - https://developer.dealerware.com/reference/getadmincontractvehiclesavailable-1.md - https://developer.dealerware.com/reference/getadmincontractvehiclesavailablesearch-1.md - https://developer.dealerware.com/reference/getadmincustomercreditcards-1.md - https://developer.dealerware.com/reference/getadmincustomeremployer-1.md - https://developer.dealerware.com/reference/getadmincustomerinsurance-1.md - https://developer.dealerware.com/reference/getadmincustomernotificationsfailed.md - https://developer.dealerware.com/reference/getadmincustomerscontracts-1.md - https://developer.dealerware.com/reference/getadmindealershipcontracts-1.md - https://developer.dealerware.com/reference/getadmindealershipcontractsmanifesttoday-1.md - https://developer.dealerware.com/reference/getadmindealershipcontractssearch-1.md - https://developer.dealerware.com/reference/getadmindealershipcustomernotes.md - https://developer.dealerware.com/reference/getadmindealershipcustomers-1.md - https://developer.dealerware.com/reference/getadmindealershipcustomersmessagesprofiles-1.md - https://developer.dealerware.com/reference/getadmindealershipcustomersremoteprofilesearch-1.md - https://developer.dealerware.com/reference/getadmindealershipcustomerssearch-1.md - https://developer.dealerware.com/reference/getadmindealershipemployees-1.md - https://developer.dealerware.com/reference/getadmindealershipemployeessearch-1.md - https://developer.dealerware.com/reference/getadmindealershipfleetscontractsandvehicles-1.md - https://developer.dealerware.com/reference/getadmindealershipserviceadvisors-1.md - https://developer.dealerware.com/reference/getadmindealershipwebhook.md - https://developer.dealerware.com/reference/getadmindealershipwebhooks.md - https://developer.dealerware.com/reference/getadmindriver-1.md - https://developer.dealerware.com/reference/getcontract-1.md - https://developer.dealerware.com/reference/getcontractnotes-1.md - https://developer.dealerware.com/reference/getcontractscontactless-1.md - https://developer.dealerware.com/reference/getcontractscontactlessdriver-1.md - https://developer.dealerware.com/reference/getcontractssaleslead.md - https://developer.dealerware.com/reference/getcontractwarranty-1.md - https://developer.dealerware.com/reference/getdealership-1.md - https://developer.dealerware.com/reference/getdealershipaddress-1.md - https://developer.dealerware.com/reference/getdealershipavailability-1.md - https://developer.dealerware.com/reference/getdealershipavailabilityintervals-1.md - https://developer.dealerware.com/reference/getdealershipavailabilityintervalscontinuous-1.md - https://developer.dealerware.com/reference/getdealershipavailabilityintervalscontinuousdaily-1.md - https://developer.dealerware.com/reference/getdealershipavailabilityintervalsdaily-1.md - https://developer.dealerware.com/reference/getdealershipcalendarbookingchannels.md - https://developer.dealerware.com/reference/getdealershipcalendarcontracts-1.md - https://developer.dealerware.com/reference/getdealershipcalendarvehicles-1.md - https://developer.dealerware.com/reference/getdealershipcontractavailablevehicles.md - https://developer.dealerware.com/reference/getdealershipemployeeroles-1.md - https://developer.dealerware.com/reference/getdealershipfleetpricing-1.md - https://developer.dealerware.com/reference/getdealershipfleets-1.md - https://developer.dealerware.com/reference/getdealershipkpis-1.md - https://developer.dealerware.com/reference/getdealershipmakesandmodels-1.md - https://developer.dealerware.com/reference/getdealershipreportreceivables-1.md - https://developer.dealerware.com/reference/getdealershipreportrevenue-1.md - https://developer.dealerware.com/reference/getdealershipreportrevenuesummary-1.md - https://developer.dealerware.com/reference/getdealershipreporttransactions-1.md - https://developer.dealerware.com/reference/getdealershipreporttransactionsfilteredsorted-1.md - https://developer.dealerware.com/reference/getdealershiproles-1.md - https://developer.dealerware.com/reference/getdealerships-1.md - https://developer.dealerware.com/reference/getdealershipsearch-1.md - https://developer.dealerware.com/reference/getdealershipsettings-1.md - https://developer.dealerware.com/reference/getdealershiptelematicssettings-1.md - https://developer.dealerware.com/reference/getdealershiptrimtypesinfleets-1.md - https://developer.dealerware.com/reference/getdealershipvehicles-1.md - https://developer.dealerware.com/reference/getdealershipvehiclessearch-1.md - https://developer.dealerware.com/reference/getdocument-1.md - https://developer.dealerware.com/reference/getemployee-1.md - https://developer.dealerware.com/reference/getfleet-1.md - https://developer.dealerware.com/reference/getfleetavailability-1.md - https://developer.dealerware.com/reference/getfleetavailabilityintervals-1.md - https://developer.dealerware.com/reference/getfleetavailabilityintervalscontinuous-1.md - https://developer.dealerware.com/reference/getfleetavailabilityintervalscontinuousdaily-1.md - https://developer.dealerware.com/reference/getfleetavailabilityintervalsdaily-1.md - https://developer.dealerware.com/reference/getfleetsettings-1.md - https://developer.dealerware.com/reference/getgeolocationradialdistance-1.md - https://developer.dealerware.com/reference/getmappablefields-1.md - https://developer.dealerware.com/reference/getprogramavailability-1.md - https://developer.dealerware.com/reference/getprogramavailabilityintervals-1.md - https://developer.dealerware.com/reference/getrentalagreementpdf-1.md - https://developer.dealerware.com/reference/getreservationcustomer-1.md - https://developer.dealerware.com/reference/getshortremoteprofile.md - https://developer.dealerware.com/reference/getuser-1.md - https://developer.dealerware.com/reference/getuserdealershiproles-1.md - https://developer.dealerware.com/reference/getuserpreferences.md - https://developer.dealerware.com/reference/getvehicle-1.md - https://developer.dealerware.com/reference/getvehicleevents-1.md - https://developer.dealerware.com/reference/getvehiclegroupdefleetsettings.md - https://developer.dealerware.com/reference/getvehicleissues-1.md - https://developer.dealerware.com/reference/getvehicletelemetry-1.md - https://developer.dealerware.com/reference/patchadminvehicle.md - https://developer.dealerware.com/reference/patchdealershipandfleetsettings-1.md - https://developer.dealerware.com/reference/postadmincontractbillingadjustment-1.md - https://developer.dealerware.com/reference/postadmincontractreceiptpdf-1.md - https://developer.dealerware.com/reference/postadmincontractsdrivers-1.md - https://developer.dealerware.com/reference/postadmincontractsettlement-1.md - https://developer.dealerware.com/reference/postadmincontractsplitbill-1.md - https://developer.dealerware.com/reference/postadmincontractsplitbilladjustment-1.md - https://developer.dealerware.com/reference/postadmincontractsplitbillpayment-1.md - https://developer.dealerware.com/reference/postadmincontractsplitbillpdf-1.md - https://developer.dealerware.com/reference/postadmincustomeremployer-1.md - https://developer.dealerware.com/reference/postadmincustomerinsurance-1.md - https://developer.dealerware.com/reference/postadmincustomernotificationreplay.md - https://developer.dealerware.com/reference/postadmindealershipcustomer-1.md - https://developer.dealerware.com/reference/postadmindealershipcustomermessage-1.md - https://developer.dealerware.com/reference/postadmindealershipcustomernote.md - https://developer.dealerware.com/reference/postadmindealershipcustomersremoteprofileqrcode.md - https://developer.dealerware.com/reference/postadmindealershipemployee-1.md - https://developer.dealerware.com/reference/postadmindealershipwebhook.md - https://developer.dealerware.com/reference/postcontactlessdriversignature-1.md - https://developer.dealerware.com/reference/postcontractcontactlessmessages-1.md - https://developer.dealerware.com/reference/postcontractnote-1.md - https://developer.dealerware.com/reference/postcontractscontactlesssignatures-1.md - https://developer.dealerware.com/reference/postcontractssaleslead.md - https://developer.dealerware.com/reference/postcontractswarranty-1.md - https://developer.dealerware.com/reference/postdealeronboardingvehicles-1.md - https://developer.dealerware.com/reference/postdealershipfleets-1.md - https://developer.dealerware.com/reference/postdealershipvehicle-1.md - https://developer.dealerware.com/reference/postdealervehiclescheckingonboardingstatus-1.md - https://developer.dealerware.com/reference/postdriversignature-1.md - https://developer.dealerware.com/reference/postemployeeactivation-1.md - https://developer.dealerware.com/reference/postfleetcontract-1.md - https://developer.dealerware.com/reference/postfleetvehicles-1.md - https://developer.dealerware.com/reference/postlogin-1.md - https://developer.dealerware.com/reference/postreportingdata.md - https://developer.dealerware.com/reference/postreportingmetadata.md - https://developer.dealerware.com/reference/postuserconfirmations-1.md - https://developer.dealerware.com/reference/postuserpasswordforgot-1.md - https://developer.dealerware.com/reference/postvehicleissue-1.md - https://developer.dealerware.com/reference/putadmincontractfinish-1.md - https://developer.dealerware.com/reference/putadmincontractpaymentmethod-1.md - https://developer.dealerware.com/reference/putadmincontractsplitbill-1.md - https://developer.dealerware.com/reference/putadmincontractstart-1.md - https://developer.dealerware.com/reference/putadmincontractswarranty-1.md - https://developer.dealerware.com/reference/putadmincontractunassignvehicle-1.md - https://developer.dealerware.com/reference/putadmincontractvehicle-1.md - https://developer.dealerware.com/reference/putadmincustomeremployer-1.md - https://developer.dealerware.com/reference/putadmincustomerupdate-1.md - https://developer.dealerware.com/reference/putadmindealershipwebhook.md - https://developer.dealerware.com/reference/putadmindriver-1.md - https://developer.dealerware.com/reference/putcontract-1.md - https://developer.dealerware.com/reference/putcontractnote-1.md - https://developer.dealerware.com/reference/putdealershipaddress-1.md - https://developer.dealerware.com/reference/putdealershipcustomernote.md - https://developer.dealerware.com/reference/putdealershipemployeeroles-1.md - https://developer.dealerware.com/reference/putdealershiptelematicssettings-1.md - https://developer.dealerware.com/reference/putemployee-1.md - https://developer.dealerware.com/reference/putfleet-1.md - https://developer.dealerware.com/reference/putfleetsettings-1.md - https://developer.dealerware.com/reference/putissue-1.md - https://developer.dealerware.com/reference/putreservationcustomer-1.md - https://developer.dealerware.com/reference/putuser-1.md - https://developer.dealerware.com/reference/putuserpassword-1.md - https://developer.dealerware.com/reference/putuserpasswordreset-1.md - https://developer.dealerware.com/reference/putuserpreference-1.md - https://developer.dealerware.com/reference/putvehiclefleet-1.md - https://developer.dealerware.com/reference/putvehiclefleets-1.md - https://developer.dealerware.com/reference/querydnr-1.md - https://developer.dealerware.com/reference/updateadmincustomerinsurance-1.md merge: pages: 174 deduped: 1048 conflicts_kept_first: 0