API ReferenceChangelogDiscussions
Log In
API Reference

Finish routes and associated missions

Finish routes and associated missions. This will set the status of all missions in the specified routes to 'finished'. This action is irreversible and can only be done if all missions in the route are in a status allowing them to be finished. A route that is not published is never finished: it is returned in routesNotFinished, and the response message names every route id skipped for that reason.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
boolean
routeIds
array of strings
length ≥ 1

List of route identifiers to finish

routeIds
boolean

If true, simulate an unload at end of route for remaining loaded missions (marks them as returned to depot). Cannot be combined with allowReschedule=true.

Headers
string
enum
Allowed:
boolean
Defaults to false
Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json