Активация кампании
Описание
Запрос на активацию кампании
Права доступа
Для использования этого метода API-токен должен иметь права:
- Кампании - Запуск
- Доступ к группам, в которых находятся кампании
Настройте права в разделе Настройки → Токены.
URL-адрес
Метод: POST
https://example.com/api/v1.1/scampaigns/activate
Параметры запроса
| Параметр | Тип | Пример | Обязательный | Описание |
|---|---|---|---|---|
| token | string | "abcdefghijklmnqrstuvwxyz" | Да | API токен |
| id | int | 1 | Да | Идентификатор кампании |
| activate_date | string | "2025-03-15T10:00:00Z" | Да | Дата активации в формате RFC 3339 |
| deactivate_date | string | "2025-03-20T15:30:00Z" | Нет | Дата деактивации в формате RFC 3339 |
| completed_date | string | "2025-04-01T18:45:00Z" | Нет | Дата завершения в формате RFC 3339 |
подсказка
Если передать start_date без значения даты, кампания активируется немедленно.
Пример запр оса
- JSON
- XML
{
"token": "abcdefghijklmnqrstuvwxyz",
"id": 1,
"start_date": "2025-04-01T18:45:00Z",
"deactivate_date": "2025-05-01T18:45:00Z",
"completed_date": "2025-05-01T18:45:00Z"
}
<xml>
<token>abcdefghijklmnqrstuvwxyz</token>
<id>1</id>
<start_date>2025-04-01T18:45:00Z</start_date>
<deactivate_date>2025-05-01T18:45:00Z</deactivate_date>
<completed_date>2025-05-01T18:45:00Z</completed_date>
</xml>
Пример ответа
- JSON
- XML
{
"data": null,
"error": 0,
"error_text": "Successful operation"
}
<xml>
<error>0</error>
<error_text>Successful operation</error_text>
</xml>
Возвращаемые параметры
| Параметр | Тип | Описание |
|---|---|---|
| error | int | Код ошибки |
| error_text | string | Текст ошибки |
| data | null | Данные не возвращаются |