Обновление
Частичное обновление сделки
POST https://do.freshoffice.ru/deal/update
Меняются только переданные поля — всё остальное в сделке остаётся как было. Так можно, например, перевести сделку на другой этап, передав только id и status_id.
Request Body
| Name | Type | Description |
|---|---|---|
| deal* | JSON |
200: OK Стандартный объект ответа
{
"status": "success",
"error": "",
"code": null,
"rows": 0,
"pages": 0,
"page": 0,
"value": "1"
}
JSON
Все доступные параметры
- id - * Код сделки
- name - Наименование сделки
- company_id - Код контрагента
- type_id - Код типа сделки
- status_id - Код статуса (этапа) сделки
- user_id - Код ответственного за сделку
- contact_id - Код контактного лица
- sum - Сумма сделки
- date_start - Дата начала
- date_finish - Дата завершения
- note - Примечание к сделке (заменяет старое)
- tags - Теги через запятую (заменяют старые)
{
"id": 12345,
"status_id": 6,
"sum": 250000
}
Примечание
Обязательный параметр — только id (код сделки) плюс хотя бы одно обновляемое поле.
Особенности частичного обновления: числовые поля со значением 0 считаются «не переданными» — поэтому сумму нельзя обнулить, а note и tags при передаче полностью заменяют старое значение.
Пример
cURL
PHP
NodeJS (Request)
curl --location --request POST 'https://do.freshoffice.ru/deal/update' \
--header 'Authorization: Bearer XXXX-XXXXXXX-XXXXXXX' \
--header 'Content-Type: application/json' \
--data-raw '{
"id": 12345,
"status_id": 6,
"sum": 250000
}
'
<?php
$curl = curl_init();
curl_setopt_array($curl, array(
CURLOPT_URL => 'https://do.freshoffice.ru/deal/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": 12345,
"status_id": 6,
"sum": 250000
}
',
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/deal/update',
'headers': {
'Authorization': 'Bearer XXXX-XXXXXXX-XXXXXXX',
'Content-Type': 'application/json'
},
body: JSON.stringify({
"id": 12345,
"status_id": 6,
"sum": 250000
})
};
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)
Предыдущая
Следующая