Add Task Tag
clickup.add_task_tag
ActionBusiness appsconnection required
Calls the ClickUp API with the connection's credentials.
Add an existing Space tag to a task by its task id. The tag must already exist in the task's Space.
Connection
- Required
- Yes — the node will not save without one
- Auth type
- API key
- Providers
- ClickUp
- Secret shape
- the API token (pk_…), or {"token": "…"}
- Config it needs
- list_id
- Resolved by
- config.connection_id, else node.connection_id
Configuration
4 fields, 2 required. A dotted path is a nested object and name[] an array of objects — the editor renders the same tree.
| Field | Type | Required | Default | Constraints | Example |
|---|---|---|---|---|---|
task_id The task id, e.g. '9hx' — the last segment of the task's URL. | string | Yes | — | — | — |
tag_name Name of the tag as it is spelt in the Space. | string | Yes | — | — | — |
custom_task_ids Treat task_id as the Workspace's custom task id (e.g. 'ABC-123') rather than ClickUp's own id. team_id becomes required when this is on. | boolean | No | false | — | — |
team_id The Workspace (team) id. Only needed — and then required — when custom_task_ids is on. | string | Conditional | — | only with custom_task_ids | — |
Example configuration
Every value below is the contract’s own example or default — nothing invented.
{
"custom_task_ids": false
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
ok True when ClickUp accepted the call. | boolean | — |
task_id The task the tag was added to. | string | — |
tag_name The tag that was added. | string | — |
{
"ok": false,
"tag_name": "",
"task_id": ""
}See Add Task Tag run in a workflow.
In a technical demo we add the ClickUp connection, drop the node on the canvas and let Workflow Health pre-flight it before the first real run.