Skip to main content
POST
Optimize a route

Authorizations

API-Key
string
header
required

Your API key, from More → API & Integrations in the dashboard, or from ht signup / ht auth login.

Body

application/json
date
string<date>
required

Route day, YYYY-MM-DD. Required.

accountId
string

Member id or username whose route to optimize. Required unless account is sent.

account
string

Same as accountId (member id or username). Wins when both are sent.

solve
boolean
default:false

true runs the full solver (time windows, working hours, skills, capacity; jobs that do not fit come back in unassigned). false only reorders the stops.

index
integer

With count: optimize only the stops from this position on.

count
integer

With index: number of stops to optimize.

constraints
object

Solver constraints (with solve=true). Keys are snake_case. Each defaults to on.

Response

Success

data
object
required
error
null
required
meta
object
required