Метод призначений для створення нового підписника в проєкті з підтвердженням підписки самим підписником. Це добре підходить для публічних форм підписки на сайтах, де можна ввести будь-який Email. Система Sender Solutions надішле такому підписнику листа, щоб він окремо підтвердив, що хоче отримувати розсилку. Це захистить базу підписників від випадкових або спеціальних помилок при введенні Email. Дані передаються у форматі application/json.

HTTP запит

• URL: https://sender-solutions.com/api/subscribers/subscribe-action/
• HTTP Метод: POST
• Content-Type: application/json

Тіло запиту (JSON)

{
    "Subscriber": {
        "Base": {
            "Id": 0,
            "Name": "Test Users"
        },
        "IsActive": true,
        "Email": "username@example.com",
        "FirstName": "Cat",
        "LastName": "Catstone",
        "Tags": ["api", "test-user"],
        "ClientUserId": "ClientUserId3",
        "CustomField1": "CustomValue1",
        "CustomField2": "CustomValue2",
        "CustomField3": "CustomValue3",
        "Address": {
            "Country": "UA",
            "City": "Odesa",
            "State": null,
            "Zip": 65000,
            "Line1": "Very Long street",
            "Line2": "building 42",
            "Line3": null
        }
    },
    "PreferredLanguage": "uk"
}

Приклад запиту з використанням cURL

curl --location 'https://sender-solutions.com/api/subscribers/subscribe-action/' \
--header 'Content-Type: application/json' \
--header 'Authorization: {{api-token}}' \
--data-raw '{
    "Subscriber": {
        "Base": {
            "Id": 0,
            "Name": "Test Users"
        },
        "IsActive": true,
        "Email": "username@example.com",
        "FirstName": "Cat",
        "LastName": "Catstone",
        "Tags": ["api", "test-user"],
        "ClientUserId": "ClientUserId3",
        "CustomField1": "CustomValue1",
        "CustomField2": "CustomValue2",
        "CustomField3": "CustomValue3",
        "Address": {
            "Country": "UA",
            "City": "Odesa",
            "State": null,
            "Zip": 65000,
            "Line1": "Very Long street",
            "Line2": "building 42",
            "Line3": null
        }
    },
    "PreferredLanguage": "uk"
}'

Опис полів

Приклад успішної відповіді. Отримання успішної відповіді означає, що підписнику було надіслано лист з підтвердженням підписки. Він має перейти за посиланням з листа та підтвердити намір про підписку.

{
    "success": true
}