Sign in

v1

latestOpenAPI 3.1.02026-08-04164270844.7 KB
Custom Fields

Edit a custom field

🔑

Required OAuth scope: customFields:write.

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

patch/api/v2/custom-fields/{customFieldId}

Path parameters

customFieldIdstring ObjectId required
Example:507f1f77bcf86cd799439011

The unique ID of the custom field.

Headers

360-api-version'v2.0' required

The version of the API.

Request body

namestring required

The name of the custom field.

Example request

{
  "name": "Department"
}

Response

Returns the updated custom field.

namestring 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.

_idstring ObjectId required

The unique ID of the custom field.

Example response

{
  "name": "Department",
  "_id": "507f1f77bcf86cd799439011"
}