Follow Up Boss icon

Follow Up Boss

Interact with the Follow Up Boss API

Actions148

Deal Custom Field → Update

AI-generated

Summary

Update a deal custom field by ID or from a list, modifying its properties such as label, choices, display settings, and order weight via the Follow Up Boss API.

Inputs

  • authentication — Authentication method to use for the Follow Up Boss API connection. Defaults to API Key if not specified. Select 'API Key' or 'OAuth2'.
  • id (required) — The ID of the deal custom field to update. Can be specified directly as a numeric ID, or selected from the list of available deal custom fields.
  • updateFields — Collection of fields to update on the deal custom field. Optional; include only the fields you wish to modify. Available sub-fields: choices (array of dropdown options), hideIfEmpty (boolean), isRecurring (boolean), label (string), orderWeight (integer for custom sorting).
  • dropdownChoiceMap — Optional fixed collection mapping previous dropdown choice positions (keys) to their new positions (values). Used to track when dropdown options are moved or renamed. If provided items have keys not present in the current field, those items will be removed.

Output shape

The updated deal custom field resource object returned by the Follow Up Boss API, reflecting all modified properties.

Success is typically indicated by a 200 response with the full custom field metadata. Specific return shape depends on the API response format at time of execution.

Examples

Example 1: Update the label and choices of a dropdown custom field.

Set id to the target custom field's ID, updateFields.choices to ['Option A', 'Option B'], updateFields.label to 'New Anniversary Date', and leave other fields at their defaults.

Links

Discussion