Skip to main content
POST
Create or Update Job

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

override
boolean | null
default:true

Specifies that the HTTP body type to be JSON and that the character set is in UTF-8.

Body

application/json
jobId
string
jobNumber
string
jobTitle
string
clientName
string
accountNumber
string
contactName
string
contactEmail
string
contactPhone
string
notes
string
lat
number<double>
lng
number<double>
address
string
statusChangeTimestamp
string
statusChangeId
string
scheduledStartDateTime
string

Date format yyyy-MM-dd'T'HH:mm'Z' or yyyy-MM-dd

jobDuration
string
arrivalWindowStart
string

Date format yyyy-MM-dd'T'HH:mm'Z'

arrivalWindowEnd
string

Date format yyyy-MM-dd'T'HH:mm'Z'

personId
string
vehicleId
string
groupName
string
personName
string
vehicleName
string
orderNumbers
string[]
status
enum<string>
Available options:
NEW,
ASSIGNED,
RECEIVED,
IN_PROGRESS,
VISITED,
CANCELLED,
MISSED,
ACCEPTED,
INCOMPLETE,
$UNKNOWN
driverNotes
string
statusHistory
object[]
actualStart
string
actualEnd
string
overrideLat
number<double>
overrideLng
number<double>
jobHistory
object[]
jobRadius
integer<int32>
eta
string
etaDistanceKms
number<double>
lastEtaCalcTime
string
primaryResource
enum<string>
Available options:
DRIVER,
VEHICLE,
$UNKNOWN
jobTypeId
string
jobType
object
jobPhotos
object[]
jobSignature
object
linkingId
string
linkedJobDescription
string
linkedJobIndex
string
resources
object[]
subStatus
object
lastServerTime
string
visitResults
object[]
subStatusLabel
string
statusLabel
string

Response

200 - application/json

createJob 200 response

job
object
errors
object[]