v1

latestOpenAPI 3.1.02026-07-241630614.2 KB

Update a custom field of a catalog

This method allows updating a custom field of a list.

patch/api/v4/catalogs/{list_id}/custom_fields/{cf_id}

Path parameters

list_idinteger required

List ID

cf_idinteger required

Custom field ID

Request body

Response

201

_total_itemsinteger

Example response

{
  "_total_items": 1,
  "_embedded": {
    "custom_fields": [
      {
        "id": 1278898091,
        "name": "New Category field name",
        "type": "category",
        "account_id": 17079858,
        "code": "GROUP",
        "sort": 500,
        "request_id": "1",
        "catalog_id": 1095,
        "is_visible": true,
        "nested": [
          {
            "id": 197,
            "value": "category 1"
          }
        ],
        "entity_type": "catalogs",
        "_links": {
          "self": {
            "href": "https://example.kommo.com/api/v4/catalogs/1095/custom_fields/1278898091"
          }
        }
      }
    ]
  }
}