Skip to main content
Routal

Dispatch a route to its driver

Emails the route's driver a public link that opens the route in the Routal Drivers app or webview.

POST
/v2/route/{id}/dispatch

Emails the route's driver a public link that opens the route in the Routal Drivers app or webview.

Calling it again re-sends the email with a freshly built link, for a driver who lost it or changed device. The route status does not change: the driver starts the route from the app.

Authorization

api_key
private_key<token>

Pass your API key as the private_key query string parameter. Generate and rotate keys in Developer Settings of your Routal workspace.

Keys stay server-side. Never ship them to a browser or mobile app.

In: query

Path Parameters

id*string

Response Body

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/v2/route/string/dispatch"
{
  "email": "john.doe@test.com",
  "public_link": "https://google.com"
}
{
  "message": "Domain not found",
  "message_id": "highway.domain.error.not_found"
}
Empty
{
  "message": "Domain not found",
  "message_id": "highway.domain.error.not_found"
}
{
  "message": "Domain not found",
  "message_id": "highway.domain.error.not_found"
}
Empty
Empty