fields

Edit field by code

Updates a field configuration. Only provided fields are updated.

patch/crm/v1/entities/{entity}/fields/{field}

Request

Base URL
https://{domain}.uspacy.ua
Auth
HTTP bearer
TypeScript
https://skmtc.dev/uspacy/apis/crm-service-2/docs/crm/v1/entities/:entity/fields/:field/patch.ts
A function with typed inputs. Its response is checked against the schema.

Request body

namestring

codestring

requiredboolean

editableboolean

showboolean

hiddenboolean

multipleboolean

fieldSectionIdinteger

default_valuestring

tooltipstring

typestring

entity_reference_idinteger

sortinteger

Example request

{
  "name": "Source",
  "code": "source",
  "editable": true,
  "show": true,
  "fieldSectionId": 11,
  "default_value": "value",
  "tooltip": "example",
  "type": "entity_reference",
  "entity_reference_id": 123,
  "sort": 90
}

Response