Skip to main content
Use this endpoint to modify an existing custom field. You can rename the field, update its description, or move it to a different folder. Supply the field’s numeric ID in the URL path along with the fields you want to change in the request body.
PUT /api/v1/custom-fields/{id}

Path Parameters

string
required
The numeric ID of the custom field to update. Must match the pattern \d+.

Request Body

string
required
The updated name for the custom field. Must be between 1 and 255 characters.
string
An optional description for the custom field.
string | null
Move the field to a different folder by providing its ID, or pass null to remove it from any folder.

Code Examples

Response

Returns 200 OK with the updated custom field object.

Response Fields

string
required
The unique identifier of the updated custom field.
string
required
The updated name of the custom field.
string
required
The data type of the field. One of shortText, longText, number, date, datetime, boolean, email, or phoneNumber.
string | null
required
The updated description, or null if none was set.

Example Response