Обновление

Частичное обновление контрагента

POST https://do.freshoffice.ru/company/update

Меняются только переданные поля — всё остальное в карточке остаётся как было. Так можно, например, сменить статус и ответственного, передав только id, status_id и user_id.

Телефоны, email-адреса и контактные лица обновляются отдельными методами — см. раздел Контакты и страницу Телефоны и Email.

Request Body

Name Type Description
company* JSON 
{
  "status": "success",
  "error": "",
  "code": null,
  "rows": 0,
  "pages": 0,
  "page": 0,
  "value": "1"
}

JSON

Все доступные параметры
  • id - * Код контрагента
  • name - Наименование компании
  • note - Примечание (заменяет старое)
  • address - Основной адрес
  • city - Город
  • country - Страна
  • region - Регион
  • url - Вэб сайт
  • activity_type - Род деятельности
  • info_source - Источник информации
  • type_id - Код типа
  • status_id - Код статуса
  • category_id - Код категории
  • group_id - Код группы
  • user_id - Код ответственного
  • person - 1 — юридическое лицо, 2 — физическое лицо
  • first_name - Имя физического лица
  • last_name - Фамилия физического лица
  • middle_name - Отчество физического лица
  • tags - Теги через запятую (заменяют старые)
  • external_code - Внешний код (1С)

{
   "id": 368132,
   "status_id": 3,
   "user_id": 37,
   "note": "Ключевой клиент, работаем с 2026 года"
}

Примечание

Обязательный параметр — только id (код контрагента) плюс хотя бы одно обновляемое поле.

Текстовые поля (note, tags, address, ...) при передаче полностью заменяют старое значение; непереданные поля не меняются и не очищаются.

Пример

curl --location --request POST 'https://do.freshoffice.ru/company/update' \
--header 'Authorization: Bearer XXXX-XXXXXXX-XXXXXXX' \
--header 'Content-Type: application/json' \
--data-raw '{
    "id": 368132,
    "status_id": 3,
    "note": "Ключевой клиент, работаем с 2026 года"
  }
  '

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://do.freshoffice.ru/company/update',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{
    "id": 368132,
    "status_id": 3,
    "note": "Ключевой клиент, работаем с 2026 года"
  }
  ',
  CURLOPT_HTTPHEADER => array(
    'Authorization: Bearer XXXXX-XXXXXXX-XXXXXXXXX',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://do.freshoffice.ru/company/update',
  'headers': {
    'Authorization': 'Bearer XXXX-XXXXXXX-XXXXXXX',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "id": 368132,
    "status_id": 3,
    "note": "Ключевой клиент, работаем с 2026 года"
  })

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

Справочники

Для контрагентов

Пользователи

Ответ

{
  "status": "success",
  "error": "",
  "code": null,
  "rows": 0,
  "pages": 0,
  "page": 0,
  "value": "1"
}
// value: 1 - контрагент обновлен, 0 - ошибка (текст в поле error)
Предыдущая
Добавление
Следующая
Контакты