• Post category:История
  • Запись изменена:03.11.2022

POST api/2.0/crm/history/category

Для этой функции требуется аутентификация. 

Описание

Создает новую категорию истории с параметрами (название, описание, т.д.), указанными в запросе.

Параметры
НазваниеОписаниеТипПример
title

sent in body
Название категории историистроковыйтекст
description

sent in body
Описание категории историистроковыйтекст
sortOrder

sent in body
Порядок категорий историиномер1234
imageName

sent in body
Название изображения категории истористроковыйтекст
Пример
POST api/2.0/crm/history/category
Host: yourportal.r7-office.ru
Content-Type: application/json
Accept: application/json

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

Возвращает
Категория истории

Пример ответа

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>