Pin waypoint stop time

Request

Pins the provided stop time value to the waypoint. Calling this endpoint "freezes" the stop time of the waypoint at provided value.

Security

ApiKeyAuth

Path

tourIdstring, (uuid)required

Unique tour identifier (generated by Better Route backend)

Example:3fa85f64-5717-4562-b3fc-2c963f66afa6

waypointIdstring, (uuid)required

Unique waypoint identifier (generated by Better Route backend)

Example:b3f1a2c4-1234-4a2b-9c3d-abcdef123456

Bodyapplication/jsonrequired

stopTimenumber, (int64), [ 1 .. 10800 ]

Stop time in seconds

Example:300

curl -i -X PUT \
  https://dev.routes.bettermile.com/v1/tours/3fa85f64-5717-4562-b3fc-2c963f66afa6/waypoints/b3f1a2c4-1234-4a2b-9c3d-abcdef123456/stop-time \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "stopTime": 300
  }'

Responses

Stop time has been successfully pinned

Bodyapplication/json

dataobject

Example:

{}

Response

{
  "data": {}
}