Удаление сделок

POST:

https://api.calltouch.ru/lead-service/v1/api/client-order/delete

HTTP-заголовки:

• 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
            }
        ]
    }
}  

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

Типовые ошибки

Если API-токен не указан, то удаление не выполняется и выводится ошибка:

{
    "meta": [],
    "data": {
        "message": "Ошибка доступа"
    }
}
   

{

 "meta": [],

 "data": {

 "message": "Ошибка доступа"

 }

} 

{
    "meta": [],
    "data": {
        "type": "validationError",
        "apiErrorData": null,
        "validationErrorData": {
            "violations": [
                {
                    "fieldPath": "orderNumbers[0]",
                    "message": "Тип значения должен быть string."
                }
            ]
        }
    }
} 

Система баллов API - механизм, регулирующий нагрузку на сервера Calltouch. Для каждого проекта выдается индивидуальное суточное количество баллов. За каждый успешно выполненный запрос списываются баллы. Подробнее читайте в статье: Система баллов API Calltouch.