PUT
Edit a waypoint
Company space For: Stock keeper, Manager · Permission: waypoints.update Conditions
  • name, when sent, must stay unique among the waypoints of the organization.
  • latitude must be between -90 and 90 and longitude between -180 and 180 when sent.
What else happens
  • Fields that are not sent keep their value; address, latitude and longitude can be reset by sending null.
  • Trip stops that already point to this waypoint keep the name and address copied when the stop was created or last re-pointed, so the change is not copied into them.
Part of Reusable trips and waypoints.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

waypoint
string
required

Identifier of the waypoint (27-character KSUID). It must belong to the current organization.

Response

WaypointResource

id
string
required

Identifier of the waypoint (27-character KSUID).

name
string
required

Name of the waypoint, unique within the organization.

address
string | null
required

Free-text address; null when none.

latitude
string | null
required

Latitude in decimal degrees between -90 and 90, returned as a string with 7 decimals; null when unknown.

longitude
string | null
required

Longitude in decimal degrees between -180 and 180, returned as a string with 7 decimals; null when unknown.

created_at
string<date-time>
required

Date and time the record was created (ISO 8601, UTC).

updated_at
string<date-time>
required

Date and time the record was last changed (ISO 8601, UTC).