update_deal_custom_field
Update a deal's custom field by ID, changing its label, type, dropdown choices, order, or read-only settings.
Instructions
Update a deals custom field. (PUT /dealCustomFields/{id})
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| id | Yes | ||
| type | Yes | The type of deals custom field. | |
| label | Yes | The user-friendly name of the custom field (e.g., "Anniversary"). | |
| choices | No | Array of options related to a deals custom field of type `Dropdown`. | |
| readOnly | No | Sets whether the field is read only or not. | |
| extraBody | No | Extra raw JSON body fields not explicitly listed above — e.g. custom.* fields when creating/updating people or deals. Keys and values are sent as-is. | |
| extraQuery | No | Extra raw query parameters not explicitly listed above — e.g. FUB custom field filters like custom.ClosingDate on /people or /deals. Keys and values are sent as-is. | |
| hideIfEmpty | No | Sets whether we will hide this field if it is empty. | |
| isRecurring | No | Whether a date field occurs every year (e.g. birthdays, anniversaries, etc.). | |
| orderWeight | No | A weighted integer for the field to assign values for custom sorting. | |
| dropdownChoiceMap | No | An optional mapping that points previous dropdown choices (keys) to their new positions (values). This is used to track when options get moved or renamed. If items are missing from the keys, they will be removed. If the mapping is not supplied, then this endpoint will try to determine if items have been moved or renamed on its own. |