Метод предназначен для создания нового подписчика в проекте с подтверждением подписки от самого подписчика. Это хорошо подходит для публичных форм подписки на сайтах, где можно ввести любой 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": "ru"
}

Пример запроса с использованием 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": "ru"
}'

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

Пример успешного ответа. Получение успешного ответа означает, что подписчику было отправлено письмо с подтверждением подписки. Он должен перейти по ссылке из письма и подтвердить намерение о подписке.

{
    "success": true
}