Create a custom job

Request

Creates a custom job

Security

ApiKeyAuth

Path

tourIdstring, (uuid)required

Unique tour identifier (generated by Better Route backend)

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

Bodyapplication/jsonrequired

rawAddressstring, [ 1 .. 500 ] characters

Address in a format suitable for geocoding

Example:"Oranienstraße 183, 10999 Berlin, DE"

countryCodestring, = 2 characters

Two letter country code defined in ISO 3166-1

Example:"DE"

externalIdstring or null, <= 200 characters

Optional ID that can used to identify the job. If provided, this value must not collide with externalId on any other job.

Example:"CUST-99213"

curl -i -X POST \
  https://dev.routes.bettermile.com/v1/tours/3fa85f64-5717-4562-b3fc-2c963f66afa6/custom-jobs \
  -H 'Content-Type: application/json' \
  -H 'x-api-key: YOUR_API_KEY_HERE' \
  -d '{
    "rawAddress": "Oranienstraße 183, 10999 Berlin, DE",
    "countryCode": "DE",
    "externalId": "CUST-99213"
  }'

Responses

Successfully created a custom job

Bodyapplication/json

jobIdstring, (uuid)

Internal ID assigned to this job by the backend

Example:"c1a4e572-89ab-4cde-8f01-234567890abc"

waypointIdstring, (uuid)

Internal ID of (potentially new) waypoint to which the job has been assigned

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

Response

{
  "jobId": "c1a4e572-89ab-4cde-8f01-234567890abc",
  "waypointId": "b3f1a2c4-1234-4a2b-9c3d-abcdef123456"
}