Update a custom field

Update an existing custom field. Only name, description, required, and field_options are editable here; field_type, parent_object, and filterable are fixed at creation. This endpoint does not accept those three fields — any value sent for them is silently ignored, not applied.

Each body field is sparse: omit a field to leave it unchanged. For name, description, and required, sending an explicit null is treated the same as omitting it — the field keeps its current value, so an existing description cannot be blanked back to empty through this endpoint. Only the fields you send with a real value are applied, so a request that sends just name renames the field and leaves its options and settings intact.

field_options is a full replacement of the option list, and editing it ripples through the whole company's data: • An option present before but absent from the new list is deleted. Deleting an option scrubs that value out of every record of this entity type — for a dropdown the record's selection is cleared, for a checkbox that one value is removed from the record's selected set — and removes it from any saved filters that referenced it (a filter left with no values is dropped). This runs across all matching records for the company and can be a large change. • An option that stays in the list is preserved along with the records that selected it. • A new value in the list is added as a selectable option. • Renaming an option (by editing its text while keeping its position) carries the new name into every record and saved filter that used the old value. Omitting field_options entirely leaves the current options untouched. This field applies only to dropdown and checkbox fields.

This is a settings/metadata change only — it does not affect inventory, Metrc, or BioTrack. Returns 404 when no field with that id belongs to the company.

Required permission: settings_permissions_custom_fields.