Перейти к основному содержимому

Добавить/обновить значения в поле компаний

к сведению

Данный метод доступен только для полей с типами: Выпадающий список (select), Связанные поля (hierarchy), Мультикнопка (multi_button)

POST /organizations/custom_fields/:field_id/options/​


URL​

https://домен_системы/api/v2/organizations/custom_fields/123/options/


Параметры​

PATH-параметры​

ПараметрТипОбязательныйОписание
field_idчислоДаID кастомного поля

Параметры тела запроса (JSON)​

ПараметрТипОбязательныйОписание
optionsмассивДаМассив значений

Примеры тела запроса (JSON):​

{
"options": [ //Добавление нового значения
{
"name": {
"ru": "Новая опция",
"en": "New option"
}
}
]
}

{
"options": [ //Обновление существующего значения
{
"id": 11016, //ID обновляемого значения,
"name": {
"ru": "Обновлённое значение",
"en": "Updated option"
}
}
]
}

{
"options": [ //Добавление нового значения для связанных полей на определённый уровень
{
"pid": 4588, //ID родительского значения
"name": {
"ru": "Новая опция",
"en": "New option"
}
}
]
}

Ответы​

Примеры ответа:​

Пример ответа
{
"data": [ //Ответ на добавление нового значения
{
"id": 11016,
"name": {
"ru": "Новая опция",
"en": "New option"
}
}
]
}

{
"data": [ //Ответ на обновление существующего значения
{
"id": 11016,
"name": {
"ru": "Обновлённое значение",
"en": "Updated option"
}
}
]
}

{
"data": [ //Ответ на добавление нового значения для связанных полей на определённый уровень
{
"id": 11016,
"name": {
"ru": "Новая опция",
"en": "New option"
}
}
]
}
Примеры ошибок
{
"errors": [
{
"code": "e-401",
"title": "Authorization error",
"details": "Username or api key is incorrect"
}
]
}

{
"errors": [
{
"code": "e-404",
"title": "Not found",
"details": "Custom field with id {99999999} does not exist"
}
]
}