clickup · Schema

CreateTaskRequest

Request body for creating a new task.

Properties

Name Type Description
name string The name of the task.
description string The task description in rich text format.
markdown_description string The task description in Markdown format.
assignees array Array of user IDs to assign to the task.
tags array Array of tag names to apply to the task.
status string The status of the task.
priority integer Task priority. 1 is Urgent, 2 is High, 3 is Normal, 4 is Low.
due_date integer Due date as Unix timestamp in milliseconds.
due_date_time boolean Whether the due date includes a time component.
time_estimate integer Time estimate in milliseconds.
start_date integer Start date as Unix timestamp in milliseconds.
start_date_time boolean Whether the start date includes a time component.
notify_all boolean Notify all assignees and watchers of task creation.
parent string The task ID of the parent task to create this as a subtask.
links_to string The task ID to link this task to.
check_required_custom_fields boolean Whether to validate required custom fields.
custom_fields array Custom field values to set on the task.
View JSON Schema on GitHub

JSON Schema

clickup-createtaskrequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/CreateTaskRequest",
  "title": "CreateTaskRequest",
  "type": "object",
  "required": [
    "name"
  ],
  "description": "Request body for creating a new task.",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the task."
    },
    "description": {
      "type": "string",
      "description": "The task description in rich text format."
    },
    "markdown_description": {
      "type": "string",
      "description": "The task description in Markdown format."
    },
    "assignees": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "description": "Array of user IDs to assign to the task."
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Array of tag names to apply to the task."
    },
    "status": {
      "type": "string",
      "description": "The status of the task."
    },
    "priority": {
      "type": "integer",
      "minimum": 1,
      "maximum": 4,
      "nullable": true,
      "description": "Task priority. 1 is Urgent, 2 is High, 3 is Normal, 4 is Low."
    },
    "due_date": {
      "type": "integer",
      "format": "int64",
      "description": "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": "Time estimate in milliseconds."
    },
    "start_date": {
      "type": "integer",
      "format": "int64",
      "description": "Start date as Unix timestamp in milliseconds."
    },
    "start_date_time": {
      "type": "boolean",
      "description": "Whether the start date includes a time component."
    },
    "notify_all": {
      "type": "boolean",
      "description": "Notify all assignees and watchers of task creation."
    },
    "parent": {
      "type": "string",
      "nullable": true,
      "description": "The task ID of the parent task to create this as a subtask."
    },
    "links_to": {
      "type": "string",
      "nullable": true,
      "description": "The task ID to link this task to."
    },
    "check_required_custom_fields": {
      "type": "boolean",
      "description": "Whether to validate required custom fields."
    },
    "custom_fields": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "description": "The custom field ID."
          },
          "value": {
            "description": "The value to set for the custom field."
          }
        }
      },
      "description": "Custom field values to set on the task."
    }
  }
}