Обновить пользовательское поле

Print Friendly, PDF & EmailРаспечатать/сохранить в PDF

PUT api/2.0/crm/{entityType}/customfield/{id}

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

Описание
Обновляет выбранное пользовательское поле с параметрами (тип объекта, заголовок поля, тип и т.д.), указанными в запросе.

Параметры

НазваниеОписаниеТипПример
id

sent in url
Идентификатор пользовательского поляномер1234
entityType

sent in url
Новый тип сущности

Допустимые значения: contact, person, company, opportunity, case
строковыйтекст
label

sent in body
Новое название полястроковыйтекст
fieldType

sent in body
Новый тип пользовательского поля

Допустимые значения: 0 (TextField), 1 (TextArea), 2 (SelectBox), 3 (CheckBox), 4 (Heading) or 5 (Date)
номер1234
position

sent in body
Новая позиция поля

необязательно
номер1234
mask

sent in body
New mask — новая маска?

Отправляется только в формате json
необязательно
строковыйтекст
Примечание

Вы можете обновить поле, если в нем нет связанных элементов. Если такие элементы существуют, будут обновлены только метка и маска. Другие параметры будут проигнорированы.

Пример
PUT api/2.0/crm/some+text/customfield/1234
Host: yourportal.r7-office.ru
Content-Type: application/json
Accept: application/json

{
  "label": "some text",
  "fieldType": 1234,
  "position": 1234,
  "mask": "some text"
}

Возвращает

Обновлённое пользовательское поле

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

application/json

{
  "status": 0,
  "response": {
    "relativeItemsCount": 0,
    "entityId": 14523423,
    "label": "Birthdate",
    "fieldValue": "2022-10-08T15:03:33.1475255Z",
    "fieldType": 5,
    "position": 10,
    "mask": "",
    "id": 0
  }
}

text/xml

<result>
  <status>0</status>
  <response>
    <relativeItemsCount>0</relativeItemsCount>
    <entityId>14523423</entityId>
    <label>Birthdate</label>
    <fieldValue>2022-10-08T15:03:33.1475255Z</fieldValue>
    <fieldType>5</fieldType>
    <position>10</position>
    <mask></mask>
    <id>0</id>
  </response>
</result>