Метод Update
Примените этот метод для обновления имени и статуса рассылки. Для этого выполните POST-запрос с входными параметрами к точке подключения, указанными ниже.
Точка подключения:
POST: https://api.exolve.ru/campaign/v1/Update
Авторизация
Передайте следующие Заголовки HTTP для успешной авторизации.
| Имя | Тип | Описание |
|---|---|---|
| Authorization | string | API-ключ приложения с Bearer перед ним. Пример: Bearer e***s0, где e***s0 замените на API-ключ вашего приложения |
Входные параметры
Передайте следующие параметры в теле запроса в JSON-формате. Параметры, отмеченные жирным шрифтом, являются обязательными.
| Параметр | Тип | Описание |
|---|---|---|
| id | uint64 | идентификатор рассылки |
| name | string | наименование рассылки |
| status | enum CampaignStatus | статус рассылки |
CampaignStatus
| Параметр | Тип | Описание |
|---|---|---|
| 2 | enum | остановить рассылку |
| 4 | enum | начать выполнение рассылки |
| 5 | enum | завершить рассылку |
Примечание
- Невозможно начать выполнение рассылки при отсутствии списка получателей.
- Нельзя изменить статус завершённой рассылки.
Выходные параметры
Пустой 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-ключ |
| 404 | Not Found | couldn’t get info from campaign by id = [id]: campaign not found | в приложении не найдена рассылка с указанным ID |
| 400 | Bad Request | invalid character ‘[character]’ looking for beginning of value | невалидное значение в одном из полей |
| 400 | Bad Request | invalid UpdateRequest.Id: value must be greater than 0 | поле id и его значение отсутствуют в запросе |
| 400 | Bad Request | invalid value for uint64 type: ‘[value]’ | невалидное или пустое значение в поле id с типом uint64 |
| 400 | Bad Request | invalid character " after object key:value pair | в запросе пропущена запятая в одном из параметров |
Примеры
Входные параметры:
{
"id": "129883751852937216",
"name": "SHOP",
"status": 2
}
Выходные параметры:
{}