Add

[POST] …/v1/campaign/add

Создание рассылки.

Входные параметры

Название	Тип данных	Обязательность	Описание
type	Enum	Обязательный	Тип рассылки
run_date	Int64	Обязательный	Дата запуска рассылки в формате Unix time в секундах
integration_key	String	Необязательный	Устаревшее поле. Ключ интеграции, через которую выполняется кампания. Если передан одновременно с `connected_integration_id`, используется `connected_integration_id`.
connected_integration_id	String	Необязательный	ID подключённой интеграции. Имеет приоритет над `integration_key` (если переданы оба поля).
run_immediately	Boolean	Обязательный	Будет ли рассылка запущена сразу после создания: `true` - Рассылка будет запушена сразу после создания (параметр `run_date` будет проигнорирован), `false` - Рассылка будет запушена в дату, у казанную в параметре `run_date`
name	String	Обязательный	Название рассылки
message	String	Обязательный	Текст сообщения рассылки
recepients	Array of CampaignRecepient	Необязательный	Массив получателей. Если не передан или пустой, используется `RetailCustomer` без фильтров (поведение по умолчанию).
file	String	Необязательный	Файл изображения, закодированный в Base64

CampaignRecepient

Модель получателей рассылки.

Название	Тип данных	Обязательность	Описание
entity_type	CampaignRecipientEntityType	Обязательный	Тип сущности получателей
filters	Array of Filter	Необязательный	Фильтры по выбранной сущности

CampaignRecipientEntityType

Допустимые значения:

RetailCustomer
Partner
CrmClient

Пример запроса

{
    "type": "SMS",
    "run_date": 1712345678,
    "connected_integration_id": "c98210addc4f4e1bb50b17a8c1299a37",
    "run_immediately": true,
    "name": "Рассылка",
    "message": "example",
    "recepients": [
        {
            "entity_type": "RetailCustomer",
            "filters": [
                { "field": "main_phone", "operator": "Exists" }
            ]
        },
        {
            "entity_type": "Partner",
            "filters": [
                { "field": "email", "operator": "Exists" }
            ]
        },
        {
            "entity_type": "CrmClient",
            "filters": [
                { "field": "phone", "operator": "Exists" }
            ]
        }
    ],
    "file": "wb5u4nu45b5y45y54y4"
}

Выходные параметры

Название	Тип данных	Описание
new_id	Int64	ID созданной рассылки

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

{
    "ok": true,
    "result": {
        "new_id": 1
    }
}