Сделки
2 минут
Удаление сделок
Запрос
POST: https://api.calltouch.ru/lead-service/v1/api/client-order/delete
- Access-Token – API-ключ
- SiteId – ID ЛК Calltouch
Тело запроса в формате JSON:
{
"orderNumbers": ["ID сделки внутри CRM 1", "ID сделки внутри CRM 2", "ID сделки внутри CRM N"]
}
На вход подается только список ID сделок в CRM. В одном запросе можно указать не более 100 сделок.
Ответ
Процесс удаления запускается сразу же после отправки запроса, после чего сразу же возвращается и ответ, пример:
{
"meta": [],
"data": {
"orders": [
{
"orderNumber": "UdvPC9bBjjLnEJ9R",
"deleteStatus": "success",
"error": null
},
{
"orderNumber": "8I21YZ2W0lvemMtr",
"deleteStatus": "success",
"error": null
}
]
}
}
{
"meta": [],
"data": {
"message": "Ошибка доступа"
}
}
Если API-токен указан не верно, то удаление не выполняется и выводится ошибка:
{
"meta": [],
"data": {
"message": "Ошибка доступа"
}
}
Параметры ответа
Параметр | Формат | Описание |
data.orders.orderNumber | string | Переданный ID сделки из внешний CRM в запросе на обновление. |
data.orders.updateStatus | string |
Статус обновления. Возможные значения:
|
data.orders.error | object | Отображется причина ошибки удаления |
Если в запросе обнаруживаются ошибки валидации, то обновление не выполняется и выводится ошибка:
{
"meta": [],
"data": {
"type": "validationError",
"apiErrorData": null,
"validationErrorData": {
"violations": [
{
"fieldPath": "orderNumbers[0]",
"message": "Тип значения должен быть string."
}
]
}
}
}
Оцените статью
Похожие статьи