Start a route export job

Starts an asynchronous job that exports a route to XLSX (ordered stops).
Pass saved_route_id to export a saved route, or locations/costing/parameters
to export the dynamic route currently on the map. Gated by the export_route feature toggle.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Route export request

string
string
string
locations
array of objects
locations
string
string
string
parameters
object
string

SavedRouteID, when set, makes the worker load locations/costing/parameters
from routing.routes instead of trusting the body — used by the "export a
saved route" path. When empty the body's Locations/Costing/Parameters are
used (the dynamic, possibly-unsaved route currently on the map).

string

TeamID scopes the saved-route load to the caller's team. It is always set
by the handler from the authenticated context (never trusted from the
request body) so a SavedRouteID export can't cross team boundaries.

Response

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