API ReferenceTask
Update a task
Updates a task's label, comments, barcode, customfields or status.
Updates a task's label, comments, barcode, custom_fields or status. Use it to correct task data before execution, or to reset a task to pending when the driver ticked it by mistake.
Authorization
api_key private_key<token>
Pass your API key as the private_key query string parameter. Generate and rotate keys in Developer Settings of your Routal workspace.
Keys stay server-side. Never ship them to a browser or mobile app.
In: query
Path Parameters
task_id*string
Task ID
Match
^[0-9a-f]{24}Query Parameters
stop_id*string
Stop ID
Match
^[0-9a-f]{24}Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X PUT "https://example.com/v2/task/string?stop_id=string" \ -H "Content-Type: application/json" \ -d '{}'{
"id": "4f75d991ac359f8c4c79d762",
"stop_id": "4f75d991ac359f8c4c79d762",
"label": "Deliver refrigerated parcel 1/2",
"comments": "Keep cold chain. Weight 12.4 kg.",
"barcode": "8410076472158",
"status": "completed",
"custom_fields": {
"sku": "SKU-4582",
"quantity": 2,
"lot_number": "L-2026-038"
},
"created_by": "4f75d991ac359f8c4c79d762",
"created_at": "2026-09-09T07:20:39.190Z",
"updated_at": "2026-09-09T07:20:39.190Z",
"deleted_at": "2026-09-09T07:20:39.190Z"
}{
"message": "Domain not found",
"message_id": "highway.domain.error.not_found"
}Empty
{
"message": "Domain not found",
"message_id": "highway.domain.error.not_found"
}{
"message": "Domain not found",
"message_id": "highway.domain.error.not_found"
}Empty
Empty