PUT api/2.0/crm/{entityType}/customfield/{id} This function requires authentication

Description

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

Parameters

Name	Description	Type	Example
id sent in url	User field id	number	1234
entityType sent in url	Entity type	string	some text
label sent in body	Field title	string	some text
fieldType sent in body	User field value	number	1234
position sent in body	Field position optional	number	1234
mask sent in body	Mask optional	string	some text

Remark

You can update field if there is no related elements. If such elements exist there will be updated only label and mask, other parameters will be ignored.

Example

PUT api/2.0/crm/some+text/customfield/1234
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "label": "some text",
  "fieldType": 1234,
  "position": 1234,
  "mask": "some text"
}

Returns

User field

Example Response

application/json

{
  "status": 0,
  "response": {
    "relativeItemsCount": 0,
    "entityId": 14523423,
    "label": "Birthdate",
    "fieldValue": "2021-02-28T13:52:30.2863557Z",
    "fieldType": 5,
    "position": 10,
    "mask": "",
    "id": 0
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <relativeItemsCount>0</relativeItemsCount>
    <entityId>14523423</entityId>
    <label>Birthdate</label>
    <fieldValue>2021-02-28T13:52:30.2863557Z</fieldValue>
    <fieldType>5</fieldType>
    <position>10</position>
    <mask></mask>
    <id>0</id>
  </response>
</result>