Live Plans

Re-optimize a plan

Re-optimize a plan. This endpoint should be used only after updating a live plan. Returns the created operation, which can be polled for the result. Use the returned id with the operations endpoints to poll for the result.

post/plans/{planId}:reoptimize

Request

Base URL
https://api.spoke.com/public/v1
Auth
HTTP basic
TypeScript
https://skmtc.dev/spoke/apis/spoke-api/docs/plans/:planId:reoptimize/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

planIdstring required

The plan id

Request body

optimizationType'reorder_changed_stops' | 'reorder_all_stops' | 'redistribute_stops_between_drivers'

The type of optimization to use

Response

The created plan_optimization operation.

idstring required

type'plan_optimization' required

doneboolean required

Whether the operation is done.

Changes

No recorded changes to this operation across all 1 revision of this API.