Sender Solutions | Opis zapytania API: tworzenie subskrybenta z potwierdzeniem zamiaru subskrypcji

Metoda przeznaczona jest do tworzenia nowego subskrybenta w projekcie z potwierdzeniem subskrypcji przez samego subskrybenta. Dobrze nadaje się do publicznych formularzy subskrypcji na witrynach, gdzie można wpisać dowolny Email. System Sender Solutions wyśle takiemu subskrybentowi wiadomość, aby osobno potwierdził, że chce otrzymywać wysyłkę. Ochroni to bazę subskrybentów przed przypadkowymi lub celowymi błędami przy wprowadzaniu Email. Dane przekazywane są w formacie application/json.

Zapytanie HTTP

URL: https://sender-solutions.com/api/subscribers/subscribe-action/
HTTP Metoda: POST
Content-Type: application/json

Treść zapytania (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"
}

Przykład zapytania z użyciem 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"
}'

Opis pól

Pole	Typ	Opis
`Subscriber.Base.Id`	number	Identyfikator Bazy subskrybentów. Obowiązkowo musi być wskazane to pole lub Subscriber.Base.Name. Jeśli przekazać niepuste wartości w oba pola, priorytet ma Subscriber.Base.Id
`Subscriber.Base.Name`	string	Nazwa Bazy subskrybentów. Obowiązkowo musi być wskazane to pole lub Subscriber.Base.Id. Jeśli przekazać niepuste wartości w oba pola, priorytet ma Subscriber.Base.Id
`Subscriber.IsActive`	boolean	Flaga aktywności subskrybenta. Po potwierdzeniu subskrypcji subskrybent będzie aktywny. To pole można zignorować.
`Subscriber.Email`	string	Email subskrybenta
`Subscriber.FirstName`	string	Imię
`Subscriber.LastName`	string	Nazwisko
`Subscriber.Gender`	string	Płeć subskrybenta. Możliwe wartości: "male" dla męskiej, "female" dla żeńskiej, ""(pusty ciąg) dla wartości "Nie wskazano". Domyślnie "Nie wskazano"
`Subscriber.Phone`	string	Numer telefonu
`Subscriber.Tags`	array[string]	Tagi subskrybenta, tablica ciągów
`Subscriber.ClientUserId`	string	ID subskrybenta w systemie klienta
`Subscriber.CustomField1`	string	Wolne pole 1, wypełnij dowolną informacją według własnego uznania.
`Subscriber.CustomField2`	string	Wolne pole 2, wypełnij dowolną informacją według własnego uznania.
`Subscriber.CustomField3`	string	Wolne pole 3, wypełnij dowolną informacją według własnego uznania.
`Subscriber.Address.Country`	string	Dwuznakowy kod kraju (ISO 3166-1 alpha-2)
`Subscriber.Address.City`	string	Miasto
`Subscriber.Address.State`	string \| null	Region / stan / województwo
`Subscriber.Address.Zip`	number	Kod pocztowy
`Subscriber.Address.Line1`	string	Główny wiersz adresu
`Subscriber.Address.Line2`	string	Dodatkowy wiersz adresu
`Subscriber.Address.Line3`	string \| null	Dodatkowy wiersz adresu
`Subscriber.Birthday`	string (YYYY-MM-DD)	Data urodzenia w formacie YYYY-MM-DD
`PreferredLanguage`	string	Kod preferowanego języka do użycia w wiadomości do subskrybenta w formacie ISO 639-1. Musi zawierać 2 małe litery łacińskie (na przykład: en, uk, ru). Domyślnie en

Przykład pomyślnej odpowiedzi. Otrzymanie pomyślnej odpowiedzi oznacza, że subskrybentowi została wysłana wiadomość z potwierdzeniem subskrypcji. Musi on przejść pod link z wiadomości i potwierdzić zamiar subskrypcji.

{
    "success": true
}

9. Opis zapytania API: tworzenie subskrybenta z potwierdzeniem zamiaru subskrypcji