Lets an external system decide when the drivers can see a tasklist in the app. An unreleased tasklist is hidden from the drivers (the app sees it as empty and it is left out of the app’s lists). A released tasklist is visible as normal. Web dispatch always sees the tasklist, released or not.
Setting Planning done on a tasklist also releases it.
Authentication
Send the company’s API key in the APIkey header, the same key used by the other /public endpoints. A missing or wrong key answers 401.
Release a tasklist
POST /public/tasks/release
Unrelease a tasklist
POST /public/tasks/unrelease
Body
Identify the tasklist in one of two ways.
Field Type Description
taskIds array of string 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 the company’s time zone. Used together with vehicleId.
If taskIds is sent, vehicleId and date are ignored.
Example
bash
curl -X POST https://
-H "Content-Type: application/json"
-H "APIkey:
released is true after /release and false after /unrelease. Repeating a call is safe.
Errors
Status When
400 Neither taskIds nor both vehicleId and date were sent, or a value has a wrong type
401 The APIkey header is missing or not valid
404 A tasklist id does not exist for the company, or the vehicle has no tasklist on that date
Only the company’s own tasklists can be changed. An id that belongs to another company is answered with 404.