Custom Waypoint

Operations on custom waypoints

Create a custom waypoint

Creates a custom waypoint by grouping provided jobs together

SecurityApiKeyAuth
Request
path Parameters
tourId
required
string <uuid>

Unique tour identifier (generated by Better Route backend)

Request Body schema: application/json
JobInternalIds (object) or JobExternalIds (object)

IDs of the jobs to be added under the custom waypoint

Address (object) or NullValue (null)

Specifies address to be used for the custom waypoint. If not provided one of the job addresses is used.

Responses
200

Successfully created a custom waypoint

400

Error response returned when the request is invalid. In most cases this implies that some data in the request is either missing or has incorrect format.

401

Error response returned when the provided API key is missing or invalid

404

Error response returned in cases the requested endpoint or data can't be found

500

Error response returned whenever the server fails to process the request

post/v1/tours/{tourId}/custom-waypoints
Request samples
application/json
{
  • "jobIds": {
    },
  • "address": {
    }
}
Response samples
application/json
{
  • "waypointId": "6eeaf5f6-415c-49ff-97fc-2d3cc3a134f5"
}

Deletes a custom waypoint

Deletes a custom waypoint, allowing the backend to regroup the jobs from this waypoint freely.

SecurityApiKeyAuth
Request
path Parameters
tourId
required
string <uuid>

Unique tour identifier (generated by Better Route backend)

waypointId
required
string <uuid>

Unique waypoint identifier (generated by Better Route backend)

Responses
200

Successfully deleted the custom waypoint

400

Error response returned when the request is invalid. In most cases this implies that some data in the request is either missing or has incorrect format.

401

Error response returned when the provided API key is missing or invalid

404

Error response returned in cases the requested endpoint or data can't be found

500

Error response returned whenever the server fails to process the request

delete/v1/tours/{tourId}/custom-waypoints/{waypointId}
Request samples 
Response samples 
application/json
{
  • "data": { }
}