---
title: "Set a task custom field value"
method: PUT
path: "/companies/{company}/tasks/{task}/custom-fields/{field}"
tags: ["Tasks"]
---

# Set a task custom field value

`PUT /companies/{company}/tasks/{task}/custom-fields/{field}`

## Request

- Base URL: `https://api.factuarea.com/v1`
- URL: `https://api.factuarea.com/v1/companies/{company}/tasks/{task}/custom-fields/{field}`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

Set the value of one custom field of the task's project. The value must fit the field type (and its options for `dropdown`/`multiselect`); `null` clears an optional field. An invalid value returns 422 `invalid_custom_field_value`.

## Path parameters

- `company` string, uuid, required
- `task` string, uuid, required
- `field` string, uuid, required

## Headers

- `Idempotency-Key` string
- `Factuarea-Version` string, date

## Request body

- SetTaskCustomFieldValueV1Request
  - `value` union, required: Value of the field: text, number, boolean, a `YYYY-MM-DD` date, an option or a list of options (`multiselect`). `null` clears the value.
    - string
    - number
    - boolean
    - string[]

## Response `200`

- object
  - `data` TaskCustomFieldValue, required: The value of one custom field of a task.
    - `id` string, uuid, required: UUID of the custom field.
    - `object` 'task_custom_field_value', required: Stripe-like discriminator. Always `task_custom_field_value` for this resource.
    - `task_id` string, uuid, required: UUID of the task.
    - `name` string, required: Field name.
    - `type` 'text' | 'number' | 'date' | 'dropdown' | 'boolean' | 'multiselect', required
    - `value` string, nullable, required: Value serialized as a string (a JSON array for `multiselect`), or `null`.

## Other responses

- `400`: `parameter_unknown` with `subcode` `retired_active_profile_header`: the retired `X-Active-Profile` header was sent; the company goes in the path. `parameter_invalid_format` on `Factuarea-Version`: the header is not a `YYYY-MM-DD` date. `unsupported_api_version`: the `Factuarea-Version` date is not a supported version.
- `401`: Missing or invalid API key.
- `403`: The request is authenticated but not allowed: the API key lacks the required scope (`insufficient_scope`), the plan does not include the public API or this feature (`addon_not_active`, `feature_not_available_in_plan`), or the module is not available with a test key (`module_not_available_in_sandbox`).
- `404`: The requested resource does not exist or belongs to another company.
- `422`: Validation failed. The `error.param` field identifies which input is invalid.
- `429`: Rate limit exceeded. Retry after the duration in `Retry-After`.
- `500`: Unexpected server error.

---

[API](https://skmtc.dev/factuarea/apis/factuarea-public-api.md) · [All operations](https://skmtc.dev/factuarea/apis/factuarea-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/factuarea/apis/factuarea-public-api/revisions/718e77934422?raw)