FOfolk
Tasks

Update a task

Changed on

Update an existing task in the workspace.

patch/v1/tasks/{taskId}

Request

  • Base URL
    https://api.folk.app
  • URL
    https://api.folk.app/v1/tasks/{taskId}
  • Auth
    HTTP bearer

Path parameters

taskIdstring required

The ID of the task to update.

Headers

Idempotency-Keystring

A unique key, such as a UUID, that makes retrying this request safe: a retry with the same key and body returns the original response without running the operation again. Keys are kept for 24 hours after the request completes.

Example:8e03978e-40d5-43e8-bc93-6894a57f9324

Request body

titlestring

The title of the task.

dueAtstring date

The due date of the task, in YYYY-MM-DD format.

dueTimestring nullable

The due time of the task, in HH:mm format.

descriptionstring nullable

The description of the task, in markdown format.

recurrenceFrequency'weekday' | 'weekly' | 'biweekly' | 'monthly' | 'quarterly' | 'yearly' | 'null' nullable

The recurrence frequency of the task. One of: weekday, weekly, biweekly, monthly, quarterly, yearly. Null if non-recurring.

isPublicboolean

Whether the task is visible to all workspace members (true) or only to its assigned users (false).

Example request

{
  "title": "Follow up with John Doe",
  "dueAt": "2025-07-17",
  "dueTime": "15:00",
  "description": "Discuss the Q3 proposal.",
  "isPublic": true,
  "entity": {
    "id": "per_55175e81-9a52-4ac3-930e-82792c23499b"
  }
}

Response

The task updated in the workspace.

deprecationsstring[]

Example response

{
  "data": {
    "id": "tsk_91118b73-5a75-480b-b8e3-a33671c35cdc",
    "title": "Follow up with John Doe",
    "description": "Discuss the Q3 proposal.",
    "entity": {
      "id": "per_55175e81-9a52-4ac3-930e-82792c23499b",
      "entityType": "person",
      "fullName": "John Doe"
    },
    "dueAt": "2025-07-17",
    "dueTime": "15:00",
    "completedAt": null,
    "recurrenceFrequency": null,
    "isPublic": true,
    "assignedUsers": [
      {
        "id": "usr_14c18444-a0c7-459a-86b0-ccd70ebcd65c",
        "fullName": "John Doe",
        "email": "john.doe@example.com"
      }
    ],
    "createdBy": {
      "id": "usr_14c18444-a0c7-459a-86b0-ccd70ebcd65c",
      "fullName": "John Doe",
      "email": "john.doe@example.com"
    },
    "createdAt": "2025-07-17T09:00:00.000Z",
    "updatedAt": "2025-07-17T09:00:00.000Z"
  },
  "deprecations": [
    "This field is deprecated"
  ]
}

Changes