Skip to main content
PATCH
/
v1
/
tasks
/
{taskId}
Update a task
curl --request PATCH \
  --url http://localhost:3333/v1/tasks/{taskId} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "status": "in_progress",
  "assigneeId": "mem_abc123",
  "frequency": "monthly",
  "department": "it",
  "reviewDate": "2025-01-01T00:00:00.000Z"
}
'
{
  "id": "tsk_abc123def456",
  "title": "Implement user authentication",
  "status": "in_progress",
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z",
  "description": "Add OAuth 2.0 authentication to the platform",
  "taskTemplateId": "frk_tt_68406e353df3bc002994acef"
}

Authorizations

​
X-API-Key
string
header
required

API key for authentication

Headers

​
X-Organization-Id
string

Organization ID (required for session auth, optional for API key auth)

Path Parameters

​
taskId
string
required

Unique task identifier

Example:

"tsk_abc123def456"

Body

application/json
​
status
enum<string>
Available options:
todo,
in_progress,
done,
not_relevant,
failed
Example:

"in_progress"

​
assigneeId
string | null

Assignee member ID, or null to unassign

Example:

"mem_abc123"

​
frequency
enum<string>
Available options:
daily,
weekly,
monthly,
quarterly,
yearly
Example:

"monthly"

​
department
enum<string>
Available options:
none,
admin,
gov,
hr,
it,
itsm,
qms
Example:

"it"

​
reviewDate
string<date-time>
Example:

"2025-01-01T00:00:00.000Z"

Response

Task updated successfully

​
id
string
required

Unique identifier for the task

Example:

"tsk_abc123def456"

​
title
string
required

Task title

Example:

"Implement user authentication"

​
status
enum<string>
required

Task status

Available options:
todo,
in_progress,
done,
blocked
Example:

"in_progress"

​
createdAt
string<date-time>
required

Task creation timestamp

Example:

"2024-01-15T10:30:00Z"

​
updatedAt
string<date-time>
required

Task last update timestamp

Example:

"2024-01-15T10:30:00Z"

​
description
string

Task description

Example:

"Add OAuth 2.0 authentication to the platform"

​
taskTemplateId
object

Task template ID

Example:

"frk_tt_68406e353df3bc002994acef"