v1

latestOpenAPI 3.0.12026-07-26222700728.0 KB

Mileage Routes

Save route

Save a route for the given mileage

post/v6/mileage/{mileageId}/route

Request body

idstring

Id of the route, required when updating an existing route

status'ACTIVE' | 'INACTIVE' | 'REMOVED'

Status of the route

Example request

{
  "id": "mrt_12345",
  "waypoints": [
    {
      "lat": "38.8977",
      "lng": "-77.0365"
    }
  ],
  "status": "ACTIVE",
  "customData": {
    "internal_key": "some_internal_key",
    "some_other_field": 23434
  }
}

Response

Success

result'SUCCESS' | 'FAILURE'

The result of the action performed.

Example response

{
  "data": {
    "id": "mrt_12345",
    "waypoints": [
      {
        "lat": "38.8977",
        "lng": "-77.0365"
      }
    ],
    "status": "ACTIVE",
    "customData": {
      "internal_key": "some_internal_key",
      "some_other_field": 23434
    }
  }
}