Job Management
Edit Jobs
API Documentation
Dispatch and Routing
Location
Account Management
Place Management
Reports
Job Management
Edit Jobs
Use this endpoint to update one or multiple jobs.
Here's the provided JSON object with the keys of the "jobs" array sorted alphabetically:
{
"jobs":[
{
"assigneeName":"",
"assigneeUsername":"",
"carryOver":1,
"contactEmail":"",
"contactName":"",
"contactPhone":"",
"confirmationEmails":"",
"customFields":[],
"day":0,
"destinationLat":37.7749,
"destinationLng":122.4194,
"destinationName":"This is a new job in San Francisco created via API",
"destinationText":"",
"dispatcherName":"",
"dispatcherUid":"",
"dispatcherUrl":"",
"id":"64d88ed519c0ae41096aa4b4",
"inputFormConfig":"",
"itemsToDropoff":0,
"itemsToPickup":0,
"label":"",
"linkedForms":"",
"linkedZones":"",
"manualChecks":"",
"number":0,
"onSiteSeconds":720,
"orderId":0,
"placeName":"This is a new job in San Francisco created via API",
"placeUid":"",
"placeUrl":"",
"priority":5,
"radius":100,
"receiverUid":"",
"scheduledEnd":0,
"scheduledStart":0,
"signatureName":"",
"signaturePdf":"",
"signatureSvg":"",
"teamId":0,
"textDispatcher":"",
"textReceiver":"",
"tsAccepted":0,
"tsAssigned":0,
"tsCheckIn":0,
"tsCheckNFC1":0,
"tsCheckNFC2":0,
"tsCheckOut":0,
"tsCreated":1691913941055,
"tsDoneFailed":0,
"tsDoneSuccess":0,
"tsRejected":0,
"tsSaved":1691913941055,
"tsScheduled":0,
"tsSignature":0,
"type":0,
"windowEnd":2400,
"windowStart":0,
"worker":"",
"workerName":""
}
],
"status":0
}
REQUEST
POST https://api.hellotracks.com/api/editjobs
{
data: {
jobs: {
"<job_id_1>" : {
"<attr_1>" : value,
...
"<attr_n>" : value,
},
"<job_id_2>" : job_2,
...
"<job_id_n>" : job_n
},
notify: boolean
}
}
Compare Job API Object to see all modifiable attributes (all which are marked as RW
in the column R/W
. You are not able to change the id
of a job, but most job properties are modifiable.
Body
Object, set field name to the id of the job to edit. The value is an obect with one or multiple fields. Follow the schema of the Job API object for the value object.
Set notify:true
if you want to generate a notification in case the progress status of this job changed.
To omit creating notifications for this job modification, set notify:false
.
The notify
attribute is optional and defaults to true
.
Here's the provided JSON object with the keys of the "jobs" array sorted alphabetically:
{
"jobs":[
{
"assigneeName":"",
"assigneeUsername":"",
"carryOver":1,
"contactEmail":"",
"contactName":"",
"contactPhone":"",
"confirmationEmails":"",
"customFields":[],
"day":0,
"destinationLat":37.7749,
"destinationLng":122.4194,
"destinationName":"This is a new job in San Francisco created via API",
"destinationText":"",
"dispatcherName":"",
"dispatcherUid":"",
"dispatcherUrl":"",
"id":"64d88ed519c0ae41096aa4b4",
"inputFormConfig":"",
"itemsToDropoff":0,
"itemsToPickup":0,
"label":"",
"linkedForms":"",
"linkedZones":"",
"manualChecks":"",
"number":0,
"onSiteSeconds":720,
"orderId":0,
"placeName":"This is a new job in San Francisco created via API",
"placeUid":"",
"placeUrl":"",
"priority":5,
"radius":100,
"receiverUid":"",
"scheduledEnd":0,
"scheduledStart":0,
"signatureName":"",
"signaturePdf":"",
"signatureSvg":"",
"teamId":0,
"textDispatcher":"",
"textReceiver":"",
"tsAccepted":0,
"tsAssigned":0,
"tsCheckIn":0,
"tsCheckNFC1":0,
"tsCheckNFC2":0,
"tsCheckOut":0,
"tsCreated":1691913941055,
"tsDoneFailed":0,
"tsDoneSuccess":0,
"tsRejected":0,
"tsSaved":1691913941055,
"tsScheduled":0,
"tsSignature":0,
"type":0,
"windowEnd":2400,
"windowStart":0,
"worker":"",
"workerName":""
}
],
"status":0
}
Here's the provided JSON object with the keys of the "jobs" array sorted alphabetically:
{
"jobs":[
{
"assigneeName":"",
"assigneeUsername":"",
"carryOver":1,
"contactEmail":"",
"contactName":"",
"contactPhone":"",
"confirmationEmails":"",
"customFields":[],
"day":0,
"destinationLat":37.7749,
"destinationLng":122.4194,
"destinationName":"This is a new job in San Francisco created via API",
"destinationText":"",
"dispatcherName":"",
"dispatcherUid":"",
"dispatcherUrl":"",
"id":"64d88ed519c0ae41096aa4b4",
"inputFormConfig":"",
"itemsToDropoff":0,
"itemsToPickup":0,
"label":"",
"linkedForms":"",
"linkedZones":"",
"manualChecks":"",
"number":0,
"onSiteSeconds":720,
"orderId":0,
"placeName":"This is a new job in San Francisco created via API",
"placeUid":"",
"placeUrl":"",
"priority":5,
"radius":100,
"receiverUid":"",
"scheduledEnd":0,
"scheduledStart":0,
"signatureName":"",
"signaturePdf":"",
"signatureSvg":"",
"teamId":0,
"textDispatcher":"",
"textReceiver":"",
"tsAccepted":0,
"tsAssigned":0,
"tsCheckIn":0,
"tsCheckNFC1":0,
"tsCheckNFC2":0,
"tsCheckOut":0,
"tsCreated":1691913941055,
"tsDoneFailed":0,
"tsDoneSuccess":0,
"tsRejected":0,
"tsSaved":1691913941055,
"tsScheduled":0,
"tsSignature":0,
"type":0,
"windowEnd":2400,
"windowStart":0,
"worker":"",
"workerName":""
}
],
"status":0
}