Update a custom field | Distru Documentation

Renames a custom field, or changes its description, whether it's required, or its dropdown or checkbox options.

Inputs

Every tool also takes the common inputs.

Field	Type	Required	Description
id	string	Yes	Custom field to update. Resolve via distru-search-custom-fields.
name	string	No	Up to 70 characters.
description	string	No	Up to 100 characters.
required	boolean	No	Must be filled in on every record.
options	object[]	No	DROPDOWN and CHECKBOX only: full option list after the update. Current options left out are deleted and removed from every record. Unchanged when omitted.
options[].name	string	Yes	No commas.
options[].previousName	string	No	Current name, when renaming; records using it switch to the new name.
options[].disabled	boolean	No	Stays on records that have it but can no longer be picked. Unchanged when omitted; new options enabled.

Output

Presence on a nested field assumes its parent exists.

Field	Type	Presence
customField	object	Always
customField.id	string	Always
customField.name	string	Always
customField.description	string	Can be null
customField.entityType	enum `ASSEMBLYBATCHCOMPANYCONTACTINVOICEPACKAGEPRODUCTPURCHASE_ORDERRETURNSALES_ORDERSTOCK_TRANSFERTASK`	Can be null
customField.fieldType	enum `CHECKBOXDATEDROPDOWNTEXT`	Always
customField.required	boolean	Always
customField.options	object[]	Always
customField.options[].name	string	Always
customField.options[].disabled	boolean	Always

What the AI reads

Renames a custom field, or changes its description, whether it's required, or its dropdown or checkbox options. It changes the field's definition, not record values, except that records using a renamed or removed option are updated to match. Its entity type and field type can't be changed; to change them, create a new field with distru-create-custom-field. Requires the custom fields settings permission. Sparse update: only the fields passed change; the rest stay as they are.