Use the Update a Custom Field endpoint to change fields that already exist in your Apollo Workspace, such as renaming a field, changing the maximum length of a text field, or updating the values available in a picklist.

Pass the field under the fields array, where each object identifies the field by its unique id. To find field IDs, call the Get a List of Fields endpoint with source: custom. It is recommended to update 1 field per request.

Only custom fields can be updated. System fields, and the child fields of a JSON field, cannot be updated.

Apollo only changes the parameters you include in your request, so you can omit any parameter that you want to leave as-is.

🚧

Updates overwrite the field's current configuration

The values you send replace the field's existing configuration for every record of that modality, and the change cannot be cleanly undone. Removing or renaming picklist options in particular can drop or rewrite data already stored on your records, so confirm the exact field and the exact new values before you call this endpoint.

Updating a picklist field

Every update to a picklist or multipicklist field must include the complete set of options you want to keep in meta.picklist_values — even when you are only renaming the field. If you omit it, the request fails with Picklist fields must have at least one option.

Because meta.picklist_values replaces the field's options, any option you leave out is removed. To rename or remap an existing option, include that option's existing id, which preserves the values already stored on your records. An option sent without its id is deleted and recreated, which orphans those stored values.