Skip to content
Products
/
/
/Custom Waypoint

Create a custom waypoint

Request

Creates a custom waypoint by grouping provided jobs together

Security
ApiKeyAuth
Path
tourIdstring, (uuid)required

Unique tour identifier (generated by Better Route backend)

Example:3fa85f64-5717-4562-b3fc-2c963f66afa6
Bodyapplication/jsonrequired
jobIdsJobInternalIds (object) or JobExternalIds (object)
One of:

IDs of the jobs to be added under the custom waypoint

addressAddress (object) or NullValue (null)
Any of:

An address

curl -i -X POST \
  https://dev.routes.bettermile.com/v1/tours/3fa85f64-5717-4562-b3fc-2c963f66afa6/custom-waypoints \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "jobIds": {
      "internalIds": [
        "c1a4e572-89ab-4cde-8f01-234567890abc"
      ]
    }
  }'

Responses

Successfully created a custom waypoint

Bodyapplication/json
waypointIdstring, (uuid)

Internal ID of the created custom waypoint

Example:"b3f1a2c4-1234-4a2b-9c3d-abcdef123456"
Response
{
  "waypointId": "b3f1a2c4-1234-4a2b-9c3d-abcdef123456"
}