跳到主要内容

Update a history category

PUT /api/2.0/crm/history/category/{id:[0-9]+}

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

Request body​

id​

type: integer

History category ID

Example: 0

title​

type: string

New history category title

Example: "string"

description​

type: string

New history category description

Example: "string"

imageName​

type: string

New image name of the history category

Example: "string"

sortOrder​

type: integer

New history category order

Example: 0

Request example​

{
  "id": 0,
  "title": "string",
  "description": "string",
  "imageName": "string",
  "sortOrder": 0
}

Returns​

Updated history category. A request that is not authenticated returns 401.

RelativeItemsCount​

type: integer

Example: 1

ImagePath​

type: string

Example: "path to image"

Title​

type: string

Example: "Title"

Description​

type: string

Example: "Description"

Color​

type: string

Example: "#a7fc00"

SortOrder​

type: integer

Example: 1

ID​

type: integer

Example: 1234

Response example​

{
  "RelativeItemsCount": 1,
  "ImagePath": "path to image",
  "Title": "Title",
  "Description": "Description",
  "Color": "#a7fc00",
  "SortOrder": 1,
  "ID": 1234
}