Skip to main content
Routal

Dispatch a route to its driver

Sends an email to the route's assigned driver containing a public driver link that opens the route in the Routal Drivers webview or mobile app.

POST
/v2/route/{id}/dispatch

Sends an email to the route's assigned driver containing a public driver link that opens the route in the Routal Drivers webview or mobile app.

Calling this endpoint again re-sends the email with a freshly built link — handy when the driver lost the email or changed device. The route status is not changed by this call; the driver starts the route from the app itself.

Authorization

api_key
private_key<token>

The Routal API authenticates requests with an API key passed as the private_key query string parameter. Generate and rotate your keys from the Developer Settings section of your Routal workspace.Never ship API keys to a browser or mobile app — they must stay server-side.

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