Get Started
Usage API
More information

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

Description

Sets the selected custom field to the entity with type and ID specified in the request.

Parameters
Name Description Type Example
entityType
sent in url
Entity type
Allowed values: contact, person, company, opportunity, case
string some text
entityid
sent in url
Entity 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

Custom field

Example Response

application/json

{
  "status": 0,
  "response": {
    "entityId": 14523423,
    "label": "Birthdate",
    "fieldValue": "2021-10-26T01:24:23.9331237Z",
    "fieldType": 5,
    "position": 10,
    "mask": "",
    "id": 0
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <entityId>14523423</entityId>
    <label>Birthdate</label>
    <fieldValue>2021-10-26T01:24:23.9331237Z</fieldValue>
    <fieldType>5</fieldType>
    <position>10</position>
    <mask></mask>
    <id>0</id>
  </response>
</result>