> ## Documentation Index
> Fetch the complete documentation index at: https://docsv4.mile.app/llms.txt
> Use this file to discover all available pages before exploring further.

# Delete vehicle maintenance schedule by ID

> Permanently deletes one maintenance schedule. A schedule that has already ended cannot be deleted.

Requires the **Edit Vehicle** permission.



## OpenAPI

````yaml /openapi/public/openapi-routing.json delete /vehicle-maintenance/{id}
openapi: 3.0.0
info:
  title: API - Routing
  version: 3.0.0
  description: API Documentation - RESTful API for field operations management.
servers:
  - url: https://apiweb.mile.app/api/v3
security:
  - bearerAuth: []
tags:
  - name: Vehicle
    description: >-
      The vehicle represents a car, bike, truck, or other form of transportation
      used in your organization. They are utilized to optimize the route
      planning process, determining the most efficient path for completing
      multiple tasks or visits. The vehicle attributes contain IDs, capacity,
      speed, working hours, tags, and constraints.


      **To see the details of vehicle object, please follow [this
      link](#tag/vehicle_model)**
  - name: Vehicle Maintenance
    description: >-
      A vehicle maintenance schedule is a period during which a vehicle is in
      the workshop and is left out of route optimization. A vehicle can have as
      many schedules as needed; two schedules of the same vehicle may not
      overlap.


      **Related Guide:** [Vehicle
      Maintenance](/pages/planning/routing/configuration/vehicle-maintenance)
  - name: Routing
    description: >-
      The **Routing** refers to process of finding the most effective routes for
      vehicles to travel from one visit to another. The optimization process
      will generate a result that could update the respective task data when
      dispatched. With the ability to handle complex constraints and variables
      such as capacity, time windows, and vehicle availability, the API can be
      customized to meet the specific needs of any business or organization.


      **This section is for the v2 of routing api, if you still use the old one,
      please follow [this link](/v1) to see documentation**.


      **Routing results** are collection of route optimization's results that
      already successfully processed and saved in the database. Routing results
      contains list of routed visits and dropped visits.


      1. Routed visits are sequence recommendation of visits/tasks list
      according to most suitable vehicle and best route.

      2. Dropped visits are list of tasks/visits that out of range of the
      calculation.


      **To see the details of routing object, please follow [this
      link](#tag/route_model)**


      ## Why use Route Optimization


      With Route Optimization API, you can establish or refine an automated
      dispatch or route planning process that improves the operational
      efficiency of your transportation needs. With parameters to express your
      unique operational objectives and constraints, and an algorithm built on
      top of the trusted Google Maps data, the service generates the best
      possible route plans to meet those constraints. Some use-case examples
      follow:


      - A **logistics company** uses Route Optimization to optimize the
      assignments of all next-day shipments, providing a route for each shipment
      that optimizes for distance and time efficiency, cost saving, on time
      delivery, and driver and end customer satisfaction.


      - A **field service provider** uses Route Optimization to find the optimal
      route and sequence for technician's service appointments, and re-optimize
      when condition changes occur, such as en route delays.


      - An **on demand food delivery** company uses Route Optimization in their
      real-time dispatch process to choose the best active driver to pick up
      several new orders and insert it in their existing routes.


      - A **medical service provider** uses Route Optimization to map health
      providers to appointments, improving the efficiency of the routes for each
      provider across their day.


      ## How Route Optimization works


      The Route Optimization API uses a number of inputs to return a route plan.
      Inputs include vehicles, visits or shipments, configurations, and
      constraints. A route plan includes tasks assignment to vehicles, the
      multi-stop routes for each vehicle, and the related metrics.
  - name: Routing Schedule
    description: >-
      A Routing Schedule runs route optimization automatically at the times you
      set, without anyone opening the app. Each schedule points at one
      Configuration Profile, which supplies the hub and the vehicles for every
      run. When Auto Dispatch is enabled, the optimized routes are dispatched to
      the field users as soon as the optimization finishes.


      **Related Guide:** [Routing
      Schedule](/pages/route-optimization/schedule/introduction)
  - name: Configuration
    description: >-
      Configuration endpoints for managing routing and optimization settings
      including time windows, constraints, and optimization parameters.
  - name: Capacity Constraint
    description: >-
      Capacity Constraint endpoints for managing vehicle capacity constraints in
      route optimization. Define weight, volume, and other capacity limits for
      vehicles.
  - name: Geotagging
    description: Geotagging endpoints for location tagging and geographic data management.
paths:
  /vehicle-maintenance/{id}:
    delete:
      tags:
        - Vehicle Maintenance
      summary: Delete vehicle maintenance schedule by ID
      description: >-
        Permanently deletes one maintenance schedule. A schedule that has
        already ended cannot be deleted.


        Requires the **Edit Vehicle** permission.
      operationId: deleteVehicleMaintenanceById
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
          description: |-
            Unique identifier of the maintenance schedule.
            **Example:** `6720a1f0c2e4b0a1000112ab`
      responses:
        '200':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                    description: Shows if the request was successful.
              example:
                status: true
        '400':
          description: Schedule already ended
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                    description: Shows if the request was successful.
                  message:
                    type: string
                    description: A short message explaining what went wrong.
                  failedCode:
                    type: string
                    description: Error code that identifies the failure.
              examples:
                endedSchedule:
                  value:
                    status: false
                    message: >-
                      Schedules that have already ended cannot be changed or
                      deleted. Nothing was saved.
                    failedCode: vehic-044
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                    description: Shows if the request was successful.
                  message:
                    type: string
                    description: A short message explaining what went wrong.
                  failedCode:
                    type: string
                    description: Error code that identifies the failure.
              examples:
                forbidden:
                  value:
                    status: false
                    message: >-
                      Access denied. You do not have permission for edit
                      vehicle. Please contact your admin to request access.
                    failedCode: sys-035
        '404':
          description: Schedule not found
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: boolean
                    description: Shows if the request was successful.
                  message:
                    type: string
                    description: A short message explaining what went wrong.
                  failedCode:
                    type: string
                    description: Error code that identifies the failure.
              examples:
                notFound:
                  value:
                    status: false
                    message: Maintenance schedule not found.
                    failedCode: vehic-043
      security:
        - bearerAuth: []
components:
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Use a valid Bearer token to authenticate.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.