Live Stops

Update an existing stop

Update a stop on live plans. When the plan is not writable, this endpoint starts an editing session and the action can be applied through a new optimization, or be discarded. It does not support updating a stop's location, the clientId, nor service fields. To do so, delete the stop and create a new one.

post/plans/{planId}/stops/{stopId}:liveUpdate

Request

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

Path parameters

planIdstring required

The plan id

stopIdstring required

The stop id

Request body

allowedDriversstring[] nullable

Driver IDs that are allowed to be assigned to this stop. These drivers must be configured as part of the plan to be valid.

activity'delivery' | 'pickup' nullable

Activity type

optimizationOrder'first' | 'last' | 'default' nullable

The preferred order of this stop in the optimized route. If not provided or "default", the stop will be placed in the optimal order, decided by the optimization algorithm. Otherwise it will be placed either "first" or "last".

packageCountnumber nullable

Number of packages in the stop

notesstring nullable

Notes for the stop

barcodesstring[]

List of barcode IDs associated with this stop

customPropertiesobject nullable

Key-value pairs of custom stop properties for this stop. The keys must be unique and match a custom stop property defined in your team.

Response

Success

pendingboolean required

Changes

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