SPspoke
Plans

Update an existing plan

Update an existing plan. If the plan writable property is false, prefer using the Live Plans API.

patch/plans/{planId}

Request

Path parameters

planIdstring required

The plan id

Request body

titlestring

The title of the plan.

driversstring[]

The drivers IDs of the plan, in the format drivers/<id>, duplicates will be ignored

depotstring nullable

The depot id, in the format depots/<id>. If not provided, the team's Main Depot will be used.

Response

The updated plan

idstring required
titlestring required

The title of the plan.

depotstring required
distributedboolean required

Whether the plan has been distributed.

writableboolean required

Whether the plan is writable using the normal Plan APIs. If this is false, you will need to use the Live Plan APIs to edit the plan. Any plan created before 2023-04-01 is not writable.

optimization'creating' | 'editing' | 'preview' | 'optimized' | 'optimizing' nullable required

The optimization state of the plan.

driversDriverIdSchema[] required

The driver IDs of the plan, in the format drivers/<id>.

routesRouteIdSchema[] required

The route IDs of the plan, in the format routes/<id>.

Changes

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