External DocumentationTo learn more, visit the ClickUp documentation.
Basic Parameters
| Parameter | Description |
|---|---|
| Assignees to Add | A comma separated list of the assignees IDs to add to the task. |
| Assignees to Remove | A comma separated list of the assignees IDs to remove from the task. |
| Description | The description of the task. |
| Parent Task | You can move a subtask to another parent task by including an existing task ID. You cannot convert a subtask to a task by using this parameter. |
| Priority | The priority of the task. |
| Status | The status of the task. For example Open. |
| Task ID | The ID of the task. Can be retrieved from the List Tasks action. |
| Task Name | The name of the task. |
| Watchers to Add | A comma separated list of the watchers IDs to add to the task. |
| Watchers to Remove | A comma separated list of the watchers IDs to remove from the task. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Custom Task IDs | If you want to reference a task by its custom task id, this value must be true. |
| Team ID | Only used when the Custom Task IDs parameter is set to true. |
Example Output
{
"id": "<string>",
"custom_id": "<string>",
"custom_item_id": 1,
"name": "<string>",
"text_content": "<string>",
"description": "<string>",
"status": {
"id": "<string>",
"status": "<string>",
"color": "<string>",
"orderindex": 1,
"type": "<string>"
},
"orderindex": "<string>",
"date_created": "<string>",
"date_updated": "<string>",
"date_closed": null,
"date_done": null,
"archived": false,
"creator": {
"id": 115386528,
"username": "<string>",
"color": "<string>",
"email": "<string>",
"profilePicture": null
},
"assignees": [],
"group_assignees": [],
"watchers": [
{
"id": 81431432,
"username": "<string>",
"color": "<string>",
"initials": "<string>",
"email": "<string>",
"profilePicture": null
}
],
"checklists": [],
"tags": [],
"parent": null,
"top_level_parent": null,
"priority": null,
"due_date": null,
"start_date": null,
"points": null,
"time_estimate": null,
"time_spent": 0,
"custom_fields": [
{
"id": "<string>",
"name": "<string>",
"type": "<string>",
"type_config": {
"options": [
{
"id": "<string>",
"name": "<string>",
"color": "<string>",
"orderindex": 1
},
{
"id": "<string>",
"name": "<string>",
"color": "<string>",
"orderindex": 2
}
]
},
"date_created": "<string>",
"hide_from_guests": false,
"required": false
},
{
"id": "<string>",
"name": "<string>",
"type": "<string>",
"type_config": {},
"date_created": "<string>",
"hide_from_guests": false,
"required": false
}
],
"dependencies": [],
"linked_tasks": [],
"locations": [],
"team_id": "<string>",
"url": "<string>",
"sharing": {
"public": false,
"public_share_expires_on": null,
"public_fields": [
"<string>",
"<string>"
],
"token": null,
"seo_optimized": false
},
"permission_level": "<string>",
"list": {
"id": "<string>",
"name": "<string>",
"access": true
},
"project": {
"id": "<string>",
"name": "<string>",
"hidden": false,
"access": true
},
"folder": {
"id": "<string>",
"name": "<string>",
"hidden": false,
"access": true
},
"space": {
"id": "<string>"
},
"attachments": []
}