v1

latestOpenAPI 3.1.02026-07-241630614.2 KB

Update custom field

This method allows to update a singular custom field of an entity(leads/contacts/companies)

patch/api/v4/{entity_type}/custom_fields/{id}

Path parameters

entity_type'leads' | 'contacts' | 'companies' required

Entity type

idinteger required

Custom field ID

Request body

namestring

Field name

sortinteger

Field sorting in the field group

group_idstring

Field group ID

is_api_onlyboolean

Defines whether the field is editable via API only. Available for all lead, contact, and company fields

remindstring

Available only for the birthday type fields. Birthday reminders setting (never, day – day before the event, week – week before the event, month – month before the event)

tracking_callbackstring

JavaScript callback function that will be executed on the page containing the Website Chat Button and Kommo webform when the data is submitted. Available for the field type tracking_data

search_instring

The ID of the linked list or its symbolic code (contacts, companies, contacts_and_companies). Available for the field type linked_entity

currencystring

The currency code for the field. Available for the field type monetary

Response

201

_total_itemsinteger

Example response

{
  "_total_items": 1,
  "_embedded": {
    "custom_fields": [
      {
        "id": 1278898087,
        "name": "New custom field name",
        "type": "textarea",
        "account_id": 17079858,
        "code": "DESCRIPTION",
        "sort": 560,
        "request_id": "0",
        "catalog_id": 1095,
        "is_deletable": true,
        "entity_type": "catalogs",
        "_links": {
          "self": {
            "href": "https://example.kommo.com/api/v4/leads/custom_fields/1278898087"
          }
        }
      }
    ]
  }
}