Skip to main content
PATCH
Update a task

Authorizations

x-api-key
string
header
required

API key for authentication. Get yours at app.heffl.com/settings/developers

Path Parameters

id
string
required

Task public ID

Body

application/json
title
string

Task title

description
string

Task description

status
enum<string>

Task status

Available options:
OPEN,
IN_PROGRESS,
ON_HOLD,
COMPLETED,
CANCELLED
priority
enum<string>

Task priority

Available options:
LOW,
MEDIUM,
HIGH
dueDate
string<date-time>

Due date

startDate
string<date-time>

Start date

{key}
any

Response

200 - application/json

OK

id
string
required

Task public ID

number
string
required

Auto-generated task number

title
string
required

Task title

status
string
required

Task status

type
string
required

Task type

createdAt
string<date-time>
required

When the task was created

description
string | null

Task description

priority
string | null

Task priority

dueDate
string<date-time> | null

Due date

startDate
string<date-time> | null

Start date