Update a custom field

PUT /api/2.0/crm/{entityType:(contact|person|company|opportunity|case)}/customfield/{id:[0-9]+}

Request

Updates the selected custom field with the parameters (entity type, field title, type, etc.) specified in the request.

Note: You can update field if there are no related elements. If such elements exist, only label and mask will be updated. Other parameters will be ignored.

Authorization

An API key is a token that you provide when making API calls. Include the token in a header parameter called Authorization.

Example: Authorization: 864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json.

Content-Typeenum of string

Can be one of: application/json.

Body

idinteger

Custom field ID

entityTypestring

New entity type

labelstring

New field title

fieldTypeinteger

New custom field type

positioninteger

New field position

maskstring

New mask

Examples

PUT /api/2.0/crm/%7BentityType:(contact%7Cperson%7Ccompany%7Copportunity%7Ccase)%7D/customfield/%7Bid:[0-9]+%7D HTTP/1.1
Accept: application/json
Content-Type: application/json
Host: example.com

curl --request PUT \
  --url 'https://example.com/api/2.0/crm/%7BentityType:(contact%7Cperson%7Ccompany%7Copportunity%7Ccase)%7D/customfield/%7Bid:[0-9]+%7D' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json'

Responses

200

Updated custom field

RelativeItemsCountintegerformat: int32

EntityIdintegerformat: int32

Labelstring

FieldValuestring

FieldTypeenum of integerformat: int32

[0 - TextField, 1 - TextArea, 2 - SelectBox, 3 - CheckBox, 4 - Heading, 5 - Date]

Can be one of: TextField, TextArea, SelectBox, CheckBox, Heading, Date.

Positionintegerformat: int32

Maskstring

IDintegerformat: int32

401

Unauthorized