Job Management
Create Jobs
API Documentation
Dispatch and Routing
Location
Account Management
Place Management
Reports
Job Management
Create Jobs
Create one or multiple jobs.
curl -X POST https://api.hellotracks.com/api/createjobs \
--header 'API-Key: ...' -d \
'
{
"data": {
"jobs": [
{
"destinationLat": 37.7749,
"destinationLng": -122.4194,
"destinationName": "Job in San Francisco created via API",
"worker": "username@company.com",
"day": 20231110
}
]
}
}
'
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/createjobs
{
data: {
jobs: [
job_1,
job_2,
...
job_n
],
sendRouteChange: <boolean>,
autoassign: <boolean>,
}
}
See also Job-API-Object to see properties of a job.
To directly assign a user, set the
worker
property in the job to the worker’s username. To get
the worker’s username, retrieve the username
in Member-API-Object, for
example via /getaccounts
.curl -X POST https://api.hellotracks.com/api/createjobs \
--header 'API-Key: ...' -d \
'
{
"data": {
"jobs": [
{
"destinationLat": 37.7749,
"destinationLng": -122.4194,
"destinationName": "Job in San Francisco created via API",
"worker": "username@company.com",
"day": 20231110
}
]
}
}
'
An array of objects, each object needs to confirm the Job API Object schema.
Note: do not set the id
field, this will be set automatically.
You can optionally set the uidSecondary
field.
If true, assigned and day set to today, notifies assignee immediately of jobs being updated. The list of jobs will be updated automatically on their device.
Indicates that the created jobs should automatically be assigned to a member. It will choose the nearest member that is available, taking the shift and day-route into account.
Response
{
status: 0,
jobs : [
job_1,
job_2,
...
job_n
]
}
Guaranteed to be set. Set to 0
if successful.
The array of all jobs created by this request.
curl -X POST https://api.hellotracks.com/api/createjobs --header 'API-Key: ...' -d '
{
"data": {
"jobs": [
{
"destinationLat": 37.7749,
"destinationLng": 122.4194,
"destinationName": "This is a new job in San Francisco created via API"
}
]
}
}
'
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
}
curl -X POST https://api.hellotracks.com/api/createjobs \
--header 'API-Key: ...' -d \
'
{
"data": {
"jobs": [
{
"destinationLat": 37.7749,
"destinationLng": -122.4194,
"destinationName": "Job in San Francisco created via API",
"worker": "username@company.com",
"day": 20231110
}
]
}
}
'
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
}