Отправка подписчика в Кампанию рассылки по API

Метод предназначен для триггерной отправки существующего Подписчика в существующую Кампанию рассылки. Данные передаются в формате application/json.

HTTP запрос

URL: https://sender-solutions.com/api/subscribers/send-subscriber-into-campaign/
HTTP Метод: POST
Content-Type: application/json

Тело запроса (JSON)

{
    "SendIntoCampaign": {
        "SubscriberId": 21,
        "CampaignId": 5,
        "Variables": {
            "myVar1": "myVar1 value",
            "myVar2": {
                "option1": "myVar2 option value"
            }
        }
    }
}

Пример запроса с использованием cURL


curl --location 'https://sender-solutions.com/api/subscribers/send-subscriber-into-campaign/' \
--header 'Content-Type: application/json' \
--header 'Authorization: {{api-token}}' \
--data '{
    "SendIntoCampaign": {
        "SubscriberId": 21,
        "CampaignId": 5,
        "Variables": {
            "myVar1": "myVar1 value",
            "myVar2": {
                "option1": "myVar2 option value"
            }
        }
    }
}'

Описание полей

Поле	Тип	Описание
`SendIntoCampaign.SubscriberId`	number	Идентификатор подписчика
`SendIntoCampaign.CampaignId`	number	Идентификатор Кампании рассылки
`SendIntoCampaign.Variables`	array	Дополнительные переменные для передачи в шаблон письма. Это объект со свободной структурой, где ключи (имена свойств) первого уровня это переменные, которые будут доступны в шаблоне. Имена переменных не должны совпадать с теми, которые доступны в шаблоне на уровне системы, такие как `subscriber`

Пример успешного ответа

{
    "success": true,
    "SendIntoCampaign": {
        "SendMessageRequestId": 41,
        "SubscriberId": 21,
        "CampaignId": 5,
        "MessageId": "kidabt3j31mo6vp611gx2yfpo4zr1a5c@sender-solutions.com"
    }
}

В теле ответа поле SendIntoCampaign.SendMessageRequestId отвечает за уникальный номер задачи на отправку одного письма. А поле SendIntoCampaign.MessageId отвечает за уникальное значение для заголовка Message-ID в письме.
Эти данные могут пригодиться для выполнения других запросов к нашему API или для обращений к технической поддержке.

4. Отправка подписчика в Кампанию рассылки по API