Get Started
Usage API
More information

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

Description

Deletes a custom field with the 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
fieldid
sent in url
Field ID number 1234
Example
DELETE api/2.0/crm/some+text/customfield/1234
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json
Returns

Custom field

Example Response

application/json

{
  "status": 0,
  "response": {
    "relativeItemsCount": 0,
    "entityId": 14523423,
    "label": "Birthdate",
    "fieldValue": "2021-10-16T17:55:51.5200485Z",
    "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-10-16T17:55:51.5200485Z</fieldValue>
    <fieldType>5</fieldType>
    <position>10</position>
    <mask></mask>
    <id>0</id>
  </response>
</result>