Pin waypoint timeframe

Request

Pins the provided timeframe to the waypoint. If the provided timeframe is NULL, the current waypoint timeframe will be removed if present. Calling this endpoint, even with the NULL timeframe, prevents the automatic timeframe resolution logic from running for the affected waypoint.

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

timeFrameTimeFrame (object) or NullValue (null)

Any of:

Time window with earliest and latest possible time

curl -i -X PUT \
  https://dev.routes.bettermile.com/v1/tours/3fa85f64-5717-4562-b3fc-2c963f66afa6/waypoints/b3f1a2c4-1234-4a2b-9c3d-abcdef123456/time-frame \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "timeFrame": {
      "earliest": "14:00:00",
      "latest": "16:00:00",
      "timezone": "Europe/Berlin"
    }
  }'

Responses

Timeframe has been successfully pinned

Bodyapplication/json

dataobject

Example:

{}

Response

{
  "data": {}
}