Skip to main content
Talk to salesStart

Update CRM custom field

Update mutable metadata on an organization CRM field definition.

PATCH/api/crm/custom-fields/{field_id}
HTTP referenceScope leads:write OR companies:write OR deals:writeUpdated September 27, 2026

This page documents the canonical HTTP contract for this endpoint.

The developer-key route scope expression is leads:write|companies:write|deals:write. The handler also requires the write scope matching the field entity: leads:write for lead, companies:write for company, or deals:write for deal. The caller must also have user-admin or internal-admin permission. For a developer key, this permission is loaded from its creator; the scope alone is insufficient. Field key/entity/data type are not update fields in CustomFieldUpdate.

Path parameters

  • field_idrequired

    string

Body parameters

  • label · optional

    string

    When present, non-empty and at most 80 characters.

  • description · optional

    string

    At most 2,000 characters.

  • options · optional

    array

    CustomFieldOption items.

  • is_filterable · optional

    boolean

  • is_sortable · optional

    boolean

  • is_searchable · optional

    boolean

  • include_in_task_context · optional

    boolean

  • include_in_sequence_variables · optional

    boolean

  • include_in_ai_context · optional

    boolean

  • ai_autofill · optional

    object

  • sync_to_leads_write_policy · optional

    string

    manual, autofill_only, manual_or_autofill, or disabled.

Errors

StatusMeaning
401Missing or invalid authentication.
403The key lacks the write scope matching the field entity, or the authenticated user lacks user-admin permission.
404Field definition not found in the caller organization.
422Invalid field metadata.

Docs