Get Started
Usage API
More information

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

Description

Updates the custom field order with the custom field list 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
fieldids
sent in body
List of custom field IDs Collection of numbers
collection
1234
Example
PUT api/2.0/crm/some+text/customfield/reorder
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "fieldids": [
    1234
  ]
}
Returns

Custom fields in the new order

Example Response

application/json

{
  "status": 0,
  "response": [
    {
      "entityId": 14523423,
      "label": "Birthdate",
      "fieldValue": "2021-10-26T01:24:23.9488398Z",
      "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.9488398Z</fieldValue>
    <fieldType>5</fieldType>
    <position>10</position>
    <mask></mask>
    <id>0</id>
  </response>
</result>