---
title: "Update an existing Custom Field"
method: PUT
path: "/v2/customfields/{id}"
tags: ["Custom Fields"]
---

# Update an existing Custom Field

`PUT /v2/customfields/{id}`

Updates an existing Custom Field and returns the updated object.

## Path parameters

- `id` string, required

## Headers

- `Authorization` string, required

## Request body

- UpdateCustomFieldV2Dto
  - `name` string — The custom field name.
  - `groupId` string — The ID of the custom fields group (prefix `CFG-`). Use -1 for no group. Defaults to -1.
  - `jobTypes` string[] — Array of job type IDs to associate with the custom field (prefix `JT-`).
  - `options` string[] — The options of the custom field (Drop Down type only).
  - `position` number — The position of the custom field.
  - `required` boolean — Indicates whether the custom field is required or not. (job only)
  - `requiredClose` boolean — Indicates whether the custom field is required to close the job. (job only)
  - `searchable` boolean — Indicates whether the custom field is searchable or not.

## Response `200`

The updated Custom Field.

- ResponseCustomFieldV2Dto
  - `id` string — The ID of the custom field (prefix `CF-`).
  - `entityType` 'JOB' | 'CLIENT' — The entity type of the custom field.
  - `name` string — The name of the custom field.
  - `type` 'Text' | 'Number' | 'Date' | 'Drop Down' | 'Checkbox' | 'Large Text' | 'File Upload' — The type of the custom field.
  - `groupId` union — The ID of the custom fields group the field belongs to (prefix `CFG-`). -1 if no group is assigned.
    - string
    - number
  - `jobTypes` ResponseGenericJobTypeV2Dto[] — The job types associated with the custom field.
    - `id` string — The ID of the job type (prefix `JT-`).
    - `name` string — The name of the job type.
  - `options` string[] — The options of the custom field.
  - `position` number — The position of the custom field.
  - `required` boolean — Indicates whether the custom field is required or not. (job only)
  - `requiredClose` boolean — Indicates whether the custom field is required to close the job. (job only)
  - `searchable` boolean — Indicates whether the custom field is searchable or not.

## Other responses

- `400` — Invalid input.
- `401` — Missing or invalid authentication token.
- `404` — Custom Field not found.

---

[API](https://skmtc.net/workiz/apis/developer-api.md) · [All operations](https://skmtc.net/workiz/apis/developer-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/workiz/developer-api/revisions/14666f4db0f8/schema)