Update a custom field

patch

https://{subdomain}.kommo.com/api/v4/{entity_type}/custom_fields/{id}

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

Path Params

entity_type

string

enum

required

Entity type

Allowed:

int32

required

Custom field ID

Body Params

name

string

Field name

sort

int32

Field sorting in the field group

group_id

string

Field group ID

is_api_only

boolean

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

required_statuses

array of objects

Array of the fields required to change a lead status

required_statuses

remind

string

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)

enums

array of objects

Available for the following field types: multiselect, radiobutton, select

enums

nested

array of objects

Nested values array. Available for the following field types: category.

nested

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

OAuth2

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201201

400400

401401

422422