clickup · Schema

UpdateTaskRequest

Request body for updating an existing task. All fields are optional.

Properties

Name	Type	Description
name	string	The updated name of the task.
description	string	The updated description in rich text format.
markdown_description	string	The updated description in Markdown format.
assignees	object	Assignee modifications.
status	string	The updated status of the task.
priority	integer	Updated task priority. 1 is Urgent, 2 is High, 3 is Normal, 4 is Low.
due_date	integer	Updated due date as Unix timestamp in milliseconds.
due_date_time	boolean	Whether the due date includes a time component.
time_estimate	integer	Updated time estimate in milliseconds.
start_date	integer	Updated start date as Unix timestamp in milliseconds.
start_date_time	boolean	Whether the start date includes a time component.
parent	string	The task ID of the parent task. Set to null to remove parent.
archived	boolean	Whether to archive or unarchive the task.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UpdateTaskRequest",
  "title": "UpdateTaskRequest",
  "type": "object",
  "description": "Request body for updating an existing task. All fields are optional.",
  "properties": {
    "name": {
      "type": "string",
      "description": "The updated name of the task."
    },
    "description": {
      "type": "string",
      "description": "The updated description in rich text format."
    },
    "markdown_description": {
      "type": "string",
      "description": "The updated description in Markdown format."
    },
    "assignees": {
      "type": "object",
      "properties": {
        "add": {
          "type": "array",
          "items": {
            "type": "integer"
          },
          "description": "Array of user IDs to add as assignees."
        },
        "rem": {
          "type": "array",
          "items": {
            "type": "integer"
          },
          "description": "Array of user IDs to remove from assignees."
        }
      },
      "description": "Assignee modifications."
    },
    "status": {
      "type": "string",
      "description": "The updated status of the task."
    },
    "priority": {
      "type": "integer",
      "minimum": 1,
      "maximum": 4,
      "nullable": true,
      "description": "Updated task priority. 1 is Urgent, 2 is High, 3 is Normal, 4 is Low."
    },
    "due_date": {
      "type": "integer",
      "format": "int64",
      "description": "Updated due date as Unix timestamp in milliseconds."
    },
    "due_date_time": {
      "type": "boolean",
      "description": "Whether the due date includes a time component."
    },
    "time_estimate": {
      "type": "integer",
      "description": "Updated time estimate in milliseconds."
    },
    "start_date": {
      "type": "integer",
      "format": "int64",
      "description": "Updated start date as Unix timestamp in milliseconds."
    },
    "start_date_time": {
      "type": "boolean",
      "description": "Whether the start date includes a time component."
    },
    "parent": {
      "type": "string",
      "nullable": true,
      "description": "The task ID of the parent task. Set to null to remove parent."
    },
    "archived": {
      "type": "boolean",
      "description": "Whether to archive or unarchive the task."
    }
  }
}