Метод DeleteFile
Примените этот метод для удаления файла со списком контактов. Для этого выполните POST запрос с входными параметрами к точке подключения, указанными ниже.
Точка подключения:
POST: https://api.exolve.ru/campaign/v1/DeleteFile
Авторизация
Передайте следующие Заголовки HTTP для успешной авторизации.
| Имя | Тип | Описание |
|---|---|---|
| Authorization | string | API-ключ приложения с Bearer перед ним. Пример: Bearer e***s0, где e***s0 замените на API-ключ вашего приложения |
Входные параметры
Передайте следующие параметры в теле запроса в JSON формате. Параметры, отмеченные жирным шрифтом, являются обязательными.
| Параметр | Тип | Описание |
|---|---|---|
| campaign_id | uint64 | идентификатор рассылки |
| file_id | uint64 | идентификатор загруженного файла |
Выходные параметры
Пустой JSON с 200 OK статусом.
Возможные ошибки
| Код | Статус | Пример сообщения | Описание |
|---|---|---|---|
| 404 | Not Found | Not Found | некорректный URL запроса |
| 401 | Unauthorized | invalid token | невалидный API-ключ |
| 400 | Bad Request | token is empty | в запросе не передан API-ключ |
| 400 | Bad Request | couldn’t parse incoming jwt token: couldn’t parse token: invalid character ‘[character]’ looking for beginning of value | невалидный API-ключ |
| 403 | Forbidden | permission denied | данные введены в неверном формате |
| 400 | Bad Request | couldn’t delete contact file: the file does not belong to the campaign | файл со списком контактов не принадлежит рассылки |
| 400 | Bad Request | invalid DeleteFileRequest.CampaignId: value must be greater than 0 | поле campaign_id и его значение отсутствуют в запросе |
| 400 | Bad Request | invalid DeleteFileRequest.FileId: value must be greater than 0 | поле file_id и его значение отсутствуют в запросе |
| 400 | Bad Request | invalid character ‘[character]’ looking for beginning of value | невалидное или пустое значение в одном из полей |
| 400 | Bad Request | invalid value for uint64 type: ‘[value]’ | невалидное или пустое значение в одном из полей с типом uint64 |
| 400 | Bad Request | invalid character " after object key:value pair | в запросе пропущена запятая в одном из параметров |
Примеры
Входные параметры:
{
"campaign_id": "12345",
"file_id": "119362165802627072"
}
Выходные параметры:
{}