API ReferenceTask
Delete a task
Removes a task from a stop.
Removes a task from a stop. The stop itself is not deleted. Avoid deleting tasks that have already been completed (status completed with a scanned barcode or comments) — that data is part of the proof of delivery and is required for traceability.
Authorization
api_key private_key<token>
The Routal API authenticates requests with an API key passed as the private_key query string parameter. Generate and rotate your keys from the Developer Settings section of your Routal workspace.Never ship API keys to a browser or mobile app — they must stay server-side.
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}Response Body
application/json
application/json
application/json
application/json
curl -X DELETE "https://example.com/v2/task/string?stop_id=string"{
"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-05-29T14:55:24.485Z",
"updated_at": "2026-05-29T14:55:24.485Z",
"deleted_at": "2026-05-29T14:55:24.485Z"
}{
"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
