Skip to main content
POST
/
api
/
editjobs
curl -X POST https://api.hellotracks.com/api/editjobs \
--header 'API-Key: ...' -d \
'
{
    "data": {
        "jobs": {
            "65e6d8f2abc1234567890001": {
                "customFields": [
                    { "key": "PO_Number", "val": "PO-2026-1234" },
                    { "key": "Department", "val": "Facilities" }
                ]
            }
        },
        "notify": false
    }
}
'

{
    "status": 0,
    "jobs": [
        {
            "id": "64d88ed519c0ae41096aa4b4",
            "day": 20251008,
            "number": 1,
            "type": 0,
            "priority": 5,
            "destinationName": "Acme Corp - Headquarters",
            "destinationText": "Main entrance, building A",
            "destinationLat": 37.7749,
            "destinationLng": -122.4194,
            "radius": 100,
            "contactName": "John Smith",
            "contactPhone": "+14155551234",
            "contactEmail": "john.smith@acme.com",
            "worker": "worker@company.com",
            "workerName": "Jane Doe",
            "workerEmail": "jane@company.com",
            "workerPhone": "+14155559876",
            "receiverUid": "abc123",
            "assigneeName": "Jane Doe",
            "assigneeUsername": "worker@company.com",
            "dispatcherName": "Dispatcher Mike",
            "dispatcherUid": "disp456",
            "textDispatcher": "Please deliver before 3 PM",
            "textReceiver": "Call customer on arrival",
            "itemsToPickup": 0,
            "itemsToDropoff": 3,
            "onSiteSeconds": 900,
            "windowStart": 800,
            "windowEnd": 1500,
            "tsCreated": 1696723200000,
            "tsSaved": 1696723245000,
            "tsAssigned": 1696723250000,
            "tsAccepted": 1696723300000,
            "tsScheduled": 1696748400000,
            "tsCheckIn": 1696752000000,
            "tsCheckOut": 1696752900000,
            "tsDoneSuccess": 1696752950000,
            "scheduledStart": 1696748400000,
            "scheduledEnd": 1696749300000,
            "orderId": 1012345,
            "fileNumber": "ORD-2024-1234",
            "uidSecondary": "EXT-9876",
            "labels": "urgent,vip",
            "carryOver": 0,
            "placeName": "Acme Corp HQ",
            "placeUid": "place789",
            "linkedForms": "delivery-form,signature-form",
            "linkedZones": "zone1,zone2",
            "teamId": 2,
            "confirmationEmails": "manager@acme.com,ops@acme.com",
            "customFields": [
                {"key": "PO_Number", "val": "PO-2024-5678"},
                {"key": "Department", "val": "Facilities"}
            ],
            "extra_number_1_key": "Weight (kg)",
            "extra_number_1_val": 45.5,
            "extra_text_1_key": "Special Instructions",
            "extra_text_1_val": "Fragile - Handle with care",
            "signatureName": "John Smith",
            "signatureSvg": "data:image/svg+xml;base64,PHN2ZyB3aWR0aD0...",
            "tsSignature": 1696752900000,
            "createdBy": "admin123",
            "createdVia": "api",
            "isTemplate": false,
            "jobType": "Delivery"
        }
    ]
}

​
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,
		sendRouteChange: boolean (optional)
	}
}
Compare Job API Object to see all modifiable attributes (all which are marked as RW). You are not able to change the id of a job, but most job properties are modifiable. Special Attributes:
  • Use worker field with a username to assign/reassign a job
  • Use receiverUid field with a UID to assign/reassign a job
  • Set receiverUid to empty string "" to unassign a job
  • Job templates can be edited using the tpl- prefix in the job ID
  • Use customFields to replace all custom fields on a job: [{"key":"...","val":"..."}]

​
Body

​
jobs
object
required
Object, set field name to the id of the job to edit. The value is an object with one or multiple fields. Follow the schema of the Job API object for the value object. For custom fields inside each job object:
  • customFields: array of key/value objects, for example [{ "key": "PO_Number", "val": "PO-2026-1234" }] (this clears and replaces all existing custom fields for that job).
curl -X POST https://api.hellotracks.com/api/editjobs \
--header 'API-Key: ...' -d \
'
{
    "data": {
        "jobs": {
            "65e6d8f2abc1234567890001": {
                "customFields": [
                    { "key": "PO_Number", "val": "PO-2026-1234" },
                    { "key": "Department", "val": "Facilities" }
                ]
            }
        },
        "notify": false
    }
}
'
​
notify
boolean
default:true
Set notify:true if you want to generate a notification in case the progress status of this job changed (e.g., job completion, rejection, check-in/out). To omit creating notifications for this job modification, set notify:false. The notify attribute is optional and defaults to true.
​
sendRouteChange
boolean
default:false
If true and the job is assigned with day set to today, notifies the assignee immediately of the route change. The list of jobs will be updated automatically on their device.
Permissions: Workers can only edit jobs for today unless the workers_edit_job setting is enabled. Changes to the day field by workers require this permission.
{
    "status": 0,
    "jobs": [
        {
            "id": "64d88ed519c0ae41096aa4b4",
            "day": 20251008,
            "number": 1,
            "type": 0,
            "priority": 5,
            "destinationName": "Acme Corp - Headquarters",
            "destinationText": "Main entrance, building A",
            "destinationLat": 37.7749,
            "destinationLng": -122.4194,
            "radius": 100,
            "contactName": "John Smith",
            "contactPhone": "+14155551234",
            "contactEmail": "john.smith@acme.com",
            "worker": "worker@company.com",
            "workerName": "Jane Doe",
            "workerEmail": "jane@company.com",
            "workerPhone": "+14155559876",
            "receiverUid": "abc123",
            "assigneeName": "Jane Doe",
            "assigneeUsername": "worker@company.com",
            "dispatcherName": "Dispatcher Mike",
            "dispatcherUid": "disp456",
            "textDispatcher": "Please deliver before 3 PM",
            "textReceiver": "Call customer on arrival",
            "itemsToPickup": 0,
            "itemsToDropoff": 3,
            "onSiteSeconds": 900,
            "windowStart": 800,
            "windowEnd": 1500,
            "tsCreated": 1696723200000,
            "tsSaved": 1696723245000,
            "tsAssigned": 1696723250000,
            "tsAccepted": 1696723300000,
            "tsScheduled": 1696748400000,
            "tsCheckIn": 1696752000000,
            "tsCheckOut": 1696752900000,
            "tsDoneSuccess": 1696752950000,
            "scheduledStart": 1696748400000,
            "scheduledEnd": 1696749300000,
            "orderId": 1012345,
            "fileNumber": "ORD-2024-1234",
            "uidSecondary": "EXT-9876",
            "labels": "urgent,vip",
            "carryOver": 0,
            "placeName": "Acme Corp HQ",
            "placeUid": "place789",
            "linkedForms": "delivery-form,signature-form",
            "linkedZones": "zone1,zone2",
            "teamId": 2,
            "confirmationEmails": "manager@acme.com,ops@acme.com",
            "customFields": [
                {"key": "PO_Number", "val": "PO-2024-5678"},
                {"key": "Department", "val": "Facilities"}
            ],
            "extra_number_1_key": "Weight (kg)",
            "extra_number_1_val": 45.5,
            "extra_text_1_key": "Special Instructions",
            "extra_text_1_val": "Fragile - Handle with care",
            "signatureName": "John Smith",
            "signatureSvg": "data:image/svg+xml;base64,PHN2ZyB3aWR0aD0...",
            "tsSignature": 1696752900000,
            "createdBy": "admin123",
            "createdVia": "api",
            "isTemplate": false,
            "jobType": "Delivery"
        }
    ]
}