Sign in

v1

latestOpenAPI 3.1.02026-07-14159142161.9 KB
custom fields (usersService)

Create field.

Create field.

post/company/v1/custom_fields/users/fields

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

OK

namestring
codestring
requiredboolean
editableboolean
showboolean
hiddenboolean
multipleboolean
fieldSectionIdinteger
default_valuestring
tooltipstring
typestring
entity_reference_idinteger
sortinteger
idinteger

Entity ID

Example response

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