Get Started
Portal api methods
Help

POST api/2.0/crm/{entityType}/{entityid}/customfield/{fieldid} This function requires authentication

Description

Sets the new user field value using the entity type, ID, field ID and value specified in the request

Parameters
Name Description Type Example
entityType
sent in url
Type string some text
entityid
sent in url
ID number 1234
fieldid
sent in url
Field ID number 1234
fieldValue
sent in body
Field Value string some text
Example
POST api/2.0/crm/some+text/1234/customfield/1234
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "fieldValue": "some text"
}
Returns

User field

Example Response

application/json

{
  "status": 0,
  "response": {
    "entityId": 14523423,
    "label": "Birthdate",
    "fieldValue": "2019-06-18T22:26:03.8161699Z",
    "fieldType": 5,
    "position": 10,
    "mask": "",
    "id": 0
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <entityId>14523423</entityId>
    <label>Birthdate</label>
    <fieldValue>2019-06-18T22:26:03.8161699Z</fieldValue>
    <fieldType>5</fieldType>
    <position>10</position>
    <mask></mask>
    <id>0</id>
  </response>
</result>