Get Started
Usage API
More information

PUT api/2.0/crm/history/category/{id} This function requires authentication

Description

Updates the selected history category with the parameters (title, description, etc.) specified in the request.

Parameters
Name Description Type Example
id
sent in url
History category ID number 1234
title
sent in body
New history category title string some text
description
sent in body
New history category description string some text
sortOrder
sent in body
New history category order number 1234
imageName
sent in body
New image name of the history category string some text
Example
PUT api/2.0/crm/history/category/1234
Host: yourportal.onlyoffice.com
Content-Type: application/json
Accept: application/json

{
  "title": "some text",
  "description": "some text",
  "sortOrder": 1234,
  "imageName": "some text"
}
Returns

Updated history category

Example Response

application/json

{
  "status": 0,
  "response": {
    "relativeItemsCount": 1,
    "imagePath": "path to image",
    "title": "Lunch",
    "description": "",
    "color": "",
    "sortOrder": 10,
    "id": 30
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <relativeItemsCount>1</relativeItemsCount>
    <imagePath>path to image</imagePath>
    <title>Lunch</title>
    <description></description>
    <color></color>
    <sortOrder>10</sortOrder>
    <id>30</id>
  </response>
</result>