v1

latestOpenAPI 3.0.0Creative Commons Attribution 3.02026-07-1314726.1 KB
tasks

Updates the specified task. This method supports patch semantics.

patch/tasks/v1/lists/{tasklist}/tasks/{task}

Path parameters

taskliststring required

Task list identifier.

taskstring required

Task identifier.

Request body

deletedboolean

Flag indicating whether the task has been deleted. For assigned tasks this field is read-only. They can only be deleted by calling tasks.delete, in which case both the assigned task and the original task (in Docs or Chat Spaces) are deleted. To delete the assigned task only, navigate to the assignment surface and unassign the task from there. The default is False.

notesstring

Notes describing the task. Tasks assigned from Google Docs cannot have notes. Optional. Maximum length allowed: 8192 characters.

webViewLinkstring

Output only. An absolute link to the task in the Google Tasks Web UI.

titlestring

Title of the task. Maximum length allowed: 1024 characters.

etagstring

ETag of the resource.

updatedstring

Output only. Last modification time of the task (as a RFC 3339 timestamp).

parentstring

Output only. Parent task identifier. This field is omitted if it is a top-level task. Use the "move" method to move the task under a different parent or to the top level. A parent task can never be an assigned task (from Chat Spaces, Docs). This field is read-only.

statusstring

Status of the task. This is either "needsAction" or "completed".

positionstring

Output only. String indicating the position of the task among its sibling tasks under the same parent task or at the top level. If this string is greater than another task's corresponding position string according to lexicographical ordering, the task is positioned after the other task under the same parent task (or at the top level). Use the "move" method to move the task to another position.

duestring

Scheduled date for the task (as an RFC 3339 timestamp). Optional. This represents the day that the task should be done, or that the task is visible on the calendar grid. It doesn't represent the deadline of the task. Only date information is recorded; the time portion of the timestamp is discarded when setting this field. It isn't possible to read or write the time that a task is scheduled for using the API.

hiddenboolean

Flag indicating whether the task is hidden. This is the case if the task had been marked completed when the task list was last cleared. The default is False. This field is read-only.

idstring

Task identifier.

completedstring

Completion date of the task (as a RFC 3339 timestamp). This field is omitted if the task has not been completed.

kindstring

Output only. Type of the resource. This is always "tasks#task".

selfLinkstring

Output only. URL pointing to this task. Used to retrieve, update, or delete this task.

Response

Successful response