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/%22some+text%22/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": "2020-12-08T17:37:04.5916406Z",
    "FieldType": 5,
    "Position": 10,
    "Mask": "",
    "id": 1234
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <EntityId>14523423</EntityId>
    <Label>Birthdate</Label>
    <FieldValue>2020-12-08T17:37:04.5916406Z</FieldValue>
    <FieldType>5</FieldType>
    <Position>10</Position>
    <Mask />
    <id>1234</id>
  </response>
</result>

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

Get information

Get help