Create Task

post

https://api.clickup.com/api/v2/list/{list_id}/task

Create a new task.

Custom Field values in the request body are only saved when the field is applicable to the task's custom_item_id. Use Get Custom Fields and each field's applied_objects to determine applicability before creating the task.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

list_id

number

required

Body Params

name

string

required

description

string

assignees

array of integers

assignees

archived

boolean

group_assignees

array of strings

Assign multiple user groups to the task.

group_assignees

tags

status

string

priority

integer | null

due_date

integer

due_date_time

boolean

time_estimate

integer

start_date

integer

start_date_time

boolean

points

number

Add Sprint Points to the task.

notify_all

boolean

If notify_all is true, the creator of the task will also be notified. Other assignees and watchers are always notified regardless of this setting.

parent

string | null

You can create a subtask by including an existing task ID.

The parent task ID you include can be a subtask, but must be in the same List specified in the path parameter.

markdown_content

string

Markdown formatted description for the task. If both markdown_content and description are provided, markdown_content will be used instead of description.

links_to

string | null

Include a task ID to create a linked dependency with your new task.

check_required_custom_fields

boolean

When creating a task via API any required Custom Fields are ignored by default (false).

You can enforce required Custom Fields by including check_required_custom_fields: true.

custom_fields

array

You can include one or more Custom Fields to set them when creating a new task.

Custom Fields that use object and array type values are nullable by sending "value": null.

Only Custom Fields applicable to the task's custom_item_id are saved. Values for fields scoped to other custom task types are ignored. Use a Get Custom Fields endpoint and check each field's applied_objects to see which fields apply to which task types before creating the task.

custom_fields

custom_item_id

number

The custom task type ID for this task. A value of 0 (default) creates a standard task type "Task".

This determines which Custom Fields from the custom_fields array are accepted.

To get a list of available custom task type IDs for your Workspace, use the Get Custom Task Types endpoint.

Response

Language

Credentials

Header

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200