v1

latestOpenAPI 3.1.02026-07-24172151607.6 KB
Custom Fields

Set Custom Field Value

Add data to a Custom field on a task.

You'll need to know the task_id of the task you want to update, and the universal unique identifier (UUID) field_id of the Custom Field you want to set.

The Custom Field must be applicable to the task's current custom_item_id. Use Get Custom Fields (check each field's applied_objects) or Get Task to find applicable field_id values.

Returns 400 if the field is not enabled for the task's custom task type.

post/v2/task/{task_id}/field/{field_id}

Path parameters

task_idstring required
Example:9hv

Enter the task ID of the task you want to update.

field_idstring required
Example:b955c4dc

Enter the universal unique identifier (UUID) of the Custom Field you want to set.

Query parameters

custom_task_idsboolean
Example:true

If you want to reference a task by its Custom Task ID, this value must be true.

team_idnumber
Example:123

When the custom_task_ids parameter is set to true, the Workspace ID must be provided using the team_id parameter.


For example: custom_task_ids=true&team_id=123.

Request body

OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR
OR

Example request

{
  "value": "https://clickup.com/api"
}

Response

object required

Example response

{}