Set Custom Field Value
clickup.set_custom_field_value
ActionBusiness appsconnection required
Calls the ClickUp API with the connection's credentials.
Write one custom field value on a task, addressed by the task id and the field id. This is the only way to set a custom field — the Update Task body cannot.
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
7 fields, 3 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 | — | — | — |
field_id The custom field's uuid, from clickup.list_custom_fields. | string | Yes | — | — | — |
value The value to write, written as text. Read as value_type says. | string | Yes | — | — | — |
value_type How to read value before sending it: text for text/URL/email fields, number for number and money fields, boolean for a checkbox, json for the structured shapes (a dropdown uuid array, or {"add": [...]} on a people or tasks field). | string | No | text | one of "text", "number", "boolean", "json" | — |
value_options Optional value_options JSON, e.g. {"time": true} on a date field. | string | No | — | json format | — |
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,
"value_type": "text"
}Output
One shape.
result
| Field | Type | Example |
|---|---|---|
ok True when ClickUp accepted the call. | boolean | — |
task_id The task that was written to. | string | — |
field_id The custom field that was written. | string | — |
{
"field_id": "",
"ok": false,
"task_id": ""
}See Set Custom Field Value 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.