Custom Job

Operations on custom jobs

Create a custom job

Creates a custom job

SecurityApiKeyAuth
Request
path Parameters
tourId
required
string <uuid>

Unique tour identifier (generated by Better Route backend)

Request Body schema: application/json
rawAddress
string [ 1 .. 500 ] characters

Address in a format suitable for geocoding

countryCode
string = 2 characters

Two letter country code defined in ISO 3166-1

externalId
string 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.

Responses
200

Successfully created a custom job

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-jobs
Request samples
application/json
{
  • "rawAddress": "string",
  • "countryCode": "US",
  • "externalId": "string"
}
Response samples
application/json
{
  • "jobId": "9d222c6d-893e-4e79-8201-3c9ca16a0f39",
  • "waypointId": "6eeaf5f6-415c-49ff-97fc-2d3cc3a134f5"
}

Deletes a custom job

Deletes a custom job

SecurityApiKeyAuth
Request
path Parameters
tourId
required
string <uuid>

Unique tour identifier (generated by Better Route backend)

jobId
required
string <uuid>

Unique job identifier (generated by Better Route backend)

Responses
200

Successfully deleted the custom job

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-jobs/{jobId}
Request samples 
Response samples 
application/json
{
  • "data": { }
}