Close icon

Close

Interact with Close CRM — manage leads, contacts, opportunities, tasks, notes, calls, emails, custom activities, pipelines, and more (80+ operations across 19 resources)

Custom Field → Update

AI-generated

Summary

Updates the name or description of a specified Custom Field within a selected Close CRM object type (Contact, Lead, Opportunity, or Shared Field).

Inputs

  • objectType (required) — The Close CRM object type containing the custom field. Options: Contact, Lead, Opportunity, Shared Field.
  • customFieldId (required) — The unique identifier of the Custom Field to update.
  • additionalFields — A collection to specify which properties to update. Supports 'name' (string) and 'description' (string).

Output shape

A single data item containing the updated field details. If the update is successful, the returned item typically mirrors the existing field configuration, possibly with the new values applied.

The Close API requires custom field updates to be sent as JSON with keys formatted as 'custom.{fieldId}'. The operation returns the updated field definition.

Examples

Example 1: Update a Lead custom field's description

Object Type: Lead, Custom Field ID: 12345, Additional Fields: Description 'Updated contact note description'

Example 2: Rename a Shared Field

Object Type: Shared Field, Custom Field ID: 67890, Additional Fields: Name 'New Shared Field Name'

Links

Discussion