Update a task

PUT/app/v1/task/{id}/

Read and write tasks.

Unlike every other public endpoint this one accepts writes, because a task is something a person asks for rather than a record of something that already happened.

A company API key is not a person, so created_by must name the team member the task is being raised for. The activity log records the key's name alongside it, so both halves are visible: who asked, and what made the call.

Authorization

X-API-KEYstring · headerrequired

Your company's API key.

Path parameters

idintegerrequired

A unique integer value identifying this task.

Request body

application/json · required

titlestringrequired

created_byintegerrequired

Team member id of the person this task is being created on behalf of. Required: an API key is not a person, so the caller must say who is acting. Shown as the task's creator.

descriptionstring

add_datestring (date)

due_datestring (date)

assigned_tointeger

Team member id to assign the task to.

statusenum

One of: Open Completed

modelenum

What the task is about: Driver, Vehicle, Trailer, Company, or - for nothing in particular. Sending Driver requires driver_record; Vehicle/Trailer requires equipment_record.

One of: - Driver Vehicle Trailer Company

driver_recordinteger

equipment_recordinteger

Response

200The record

idinteger

created_byobject

Show fields

idinteger

namestring

assigned_toobject

Show fields

idinteger

namestring

driver_recordobject

Show fields

idinteger

namestring

equipment_recordobject

Show fields

idinteger

unit_nostring

typeenum

One of: Vehicle Trailer

record_namestring

titlestring

descriptionstring

add_datestring (date)

due_datestring (date)

statusenum

One of: Open Completed

modelenum

One of: - Driver Vehicle Trailer Company

created_atstring (date-time)

updated_atstring (date-time)