Tasks

Update a task

Updates an existing task. Only provided fields will be updated.

patch/tasks/{id}

Request

  • Base URL: https://api.heffl.com/api/v1
  • URL: https://api.heffl.com/api/v1/tasks/{id}
  • Auth: API key in header x-api-key

Path parameters

idstring required

Task public ID

Request body

titlestring

Task title

descriptionstring

Task description

status'OPEN' | 'IN_PROGRESS' | 'ON_HOLD' | 'COMPLETED' | 'CANCELLED'

Task status

priority'LOW' | 'MEDIUM' | 'HIGH'

Task priority

dueDatestring date-time

Due date

startDatestring date-time

Start date

Response

OK

idstring required

Task public ID

numberstring required

Auto-generated task number

titlestring required

Task title

descriptionstring nullable

Task description

statusstring required

Task status

typestring required

Task type

prioritystring nullable

Task priority

dueDatestring date-time nullable

Due date

startDatestring date-time nullable

Start date

createdAtstring date-time required

When the task was created

Changes

No recorded changes to this operation across all 1 revision of this API.