Надсилання підписника до Кампанії розсилки через 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