Articles on: Dispatching

Releasing and unreleasing Tasklist for through API for Developers

Guide: How to release and unrelease tasklists for drivers



About releasing tasklists


You can hold a tasklist back while you are still planning it. An unreleased tasklist cannot be selected by drivers in the app. When the tasklist is ready, you release it and drivers can select it as usual.


You can release a tasklist yourself from Dispatching, have it released when you mark planning as done, and choose whether tasklists created by a tray or by VRP start as unreleased.


Good to know: Tasklists are released unless you choose otherwise, so nothing changes for your drivers until you start using this feature.


For integrations: release and unrelease by API


If you plan in another system, that system can release and unrelease tasklists in Dropboy through the external API. It works the same way as the release button in Dispatching:


  • An unreleased tasklist is hidden from drivers in the app. A released tasklist is visible as normal.
  • Dispatching on the web always shows the tasklist, released or not.
  • Marking planning as done on a tasklist also releases it.


This part is written for the developer who builds the integration.


Endpoints


Action

Method and path

Release a tasklist

POST ``https://api.wuxus.com/public/tasks/release

Unrelease a tasklist

POST ``https://api.wuxus.com/public/tasks/unrelease


Authentication


Send your company's API key in the APIkey header. It is the same key you use for the other /public endpoints. A missing or wrong key is answered with 401.


Request body


Send JSON. Identify the tasklist in one of two ways: by its id, or by vehicle and date.


Field

Type

Description

taskIds

array of string

The tasklist ids. Use this when you know them.

vehicleId

string

The vehicle of the tasklist. Use together with date instead of taskIds.

date

string (date)

The day of the tasklist, in your company's time zone, in the format YYYY-MM-DD. Use together with vehicleId.


If taskIds is sent, vehicleId and date are ignored.


Examples


Unrelease by vehicle and date:


curl -X POST https://api.wuxus.com/public/tasks/unrelease \
-H "Content-Type: application/json" \
-H "APIkey: <your key>" \
-d '{ "vehicleId": "5f0c...", "date": "2026-11-09" }'


Release by tasklist id:


curl -X POST https://api.wuxus.com/public/tasks/release \
-H "Content-Type: application/json" \
-H "APIkey: <your key>" \
-d '{ "taskIds": ["6aec7fc95bfa3800500b6f7b"] }'


Response


{
"success": true,
"result": {
"taskIds": ["6aec7fc95bfa3800500b6f7b"],
"released": false
}
}


released is true after a release call and false after an unrelease call. Repeating a call is safe.


Errors


Status

When

400

Neither taskIds nor both vehicleId and date were sent, or a value has the wrong type.

401

The APIkey header is missing or not valid.

404

A tasklist id does not exist for your company, or the vehicle has no tasklist on that date.


Good to know: Only your own company's tasklists can be changed. An id that belongs to another company is answered with 404




Need help?


Contact us at support@dropboy.com or visit www.dropboy.com.

Updated on: 15/11/2026

Was this article helpful?

Share your feedback

Cancel

Thank you!