Update a Custom Field

Update the details of an existing contract custom field. Only the fields included in the request body will be updated. The field type cannot be changed. Requires System Admin permissions.

Path Params
string
required

The unique identifier of the custom field (CUID format, 24 characters).

Body Params

The payload to update a contract custom field. The field type cannot be changed. Requires System Admin permissions.

string
length between 3 and 64

The custom field's new display name. Must be 3 to 64 characters, and unique within the account (case-insensitive).

values
array of objects
length between 1 and 50

For "list" fields, the full set of options. This replaces whatever options already exist. To keep an option, include its "id" (change the label to rename it). To add a new option, leave out the id. To remove an option, just leave it off the list. Any existing records using a removed option will show it as empty. Provide 1 to 50 options.

values
string

The ID of an existing option to keep or rename. Leave this out to add a new option instead.

string
required
length ≥ 1

The display name for that list option.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json