---
title: "Edit a custom field"
method: PATCH
path: "/api/v2/custom-fields/{customFieldId}"
tags: ["Custom Fields"]
---

# Edit a custom field

`PATCH /api/v2/custom-fields/{customFieldId}`

> 🔑
>
> Required OAuth scope: `customFields:write`.

Edits specific fields of an existing custom field. Fields not included in the request payload remain unchanged.

## Path parameters

- `customFieldId` string, ObjectId, required

## Headers

- `360-api-version` 'v2.0', required

## Request body

- UpdateCustomFieldBody
  - `name` string, required — The name of the custom field.

## Response `200`

Returns the updated custom field.

- CustomFieldDTO
  - `name` string, required — The name of the custom field.
  - `targetType` 'users' | 'contents', required — The resource type to which the custom field is linked.
  - `type` 'string' | 'date', required — The type of the custom field.
  - `_id` string, ObjectId, required — The unique ID of the custom field.

## Other responses

- `400` — The server cannot or will not process the request due to something that is perceived to be a client error.
- `401` — The given access token is either missing, invalid, has expired, or has been revoked.
- `403` — The given access token does not have the required OAuth scope to execute the request.
- `404` — The given `customFieldId` does not correspond to any existing custom field.
- `429` — The client has sent too many requests in a short amount of time.

---

[API](https://skmtc.net/360learning/apis/core-api.md) · [All operations](https://skmtc.net/360learning/apis/core-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/360learning/core-api/versions/94b691b0b72c/schema)