Sender Solutions | Popis API požadavku: vytvoření odběratele s potvrzením úmyslu odběru

Metoda je určena k vytvoření nového odběratele v projektu s potvrzením odběru samotným odběratelem. To se dobře hodí pro veřejné formuláře odběru na webech, kde lze zadat jakýkoli Email. Systém Sender Solutions zašle takovému odběrateli e-mail, aby zvlášť potvrdil, že chce dostávat rozesílku. To ochrání databázi odběratelů před náhodnými nebo záměrnými chybami při zadávání Emailu. Data se předávají ve formátu application/json.

HTTP požadavek

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

Tělo požadavku (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"
}

Příklad požadavku s použitím 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"
}'

Popis polí

Pole	Typ	Popis
`Subscriber.Base.Id`	number	Identifikátor Databáze odběratelů. Musí být povinně uvedeno toto pole nebo Subscriber.Base.Name. Pokud předáte neprázdné hodnoty do obou polí, přednost má Subscriber.Base.Id
`Subscriber.Base.Name`	string	Název Databáze odběratelů. Musí být povinně uvedeno toto pole nebo Subscriber.Base.Id. Pokud předáte neprázdné hodnoty do obou polí, přednost má Subscriber.Base.Id
`Subscriber.IsActive`	boolean	Příznak aktivity odběratele. Po potvrzení odběru bude odběratel aktivní. Toto pole lze ignorovat.
`Subscriber.Email`	string	E-mail odběratele
`Subscriber.FirstName`	string	Jméno
`Subscriber.LastName`	string	Příjmení
`Subscriber.Gender`	string	Pohlaví odběratele. Možné hodnoty: "male" pro mužské, "female" pro ženské, ""(prázdný řetězec) pro hodnotu "Neuvedeno". Výchozí "Neuvedeno"
`Subscriber.Phone`	string	Telefonní číslo
`Subscriber.Tags`	array[string]	Tagy odběratele, pole řetězců
`Subscriber.ClientUserId`	string	ID odběratele v systému klienta
`Subscriber.CustomField1`	string	Volné pole 1, vyplňte libovolnou informaci dle vlastního uvážení.
`Subscriber.CustomField2`	string	Volné pole 2, vyplňte libovolnou informaci dle vlastního uvážení.
`Subscriber.CustomField3`	string	Volné pole 3, vyplňte libovolnou informaci dle vlastního uvážení.
`Subscriber.Address.Country`	string	Dvouznakový kód země (ISO 3166-1 alpha-2)
`Subscriber.Address.City`	string	Město
`Subscriber.Address.State`	string \| null	Region / stát / oblast
`Subscriber.Address.Zip`	number	Poštovní směrovací číslo
`Subscriber.Address.Line1`	string	Hlavní řádek adresy
`Subscriber.Address.Line2`	string	Doplňkový řádek adresy
`Subscriber.Address.Line3`	string \| null	Doplňkový řádek adresy
`Subscriber.Birthday`	string (YYYY-MM-DD)	Datum narození ve formátu YYYY-MM-DD
`PreferredLanguage`	string	Kód preferovaného jazyka pro použití v e-mailu odběrateli ve formátu ISO 639-1. Musí obsahovat 2 malá latinská písmena (například: en, uk, ru). Výchozí en

Příklad úspěšné odpovědi. Získání úspěšné odpovědi znamená, že odběrateli byl odeslán e-mail s potvrzením odběru. Musí přejít na odkaz z e-mailu a potvrdit úmysl odběru.

{
    "success": true
}

9. Popis API požadavku: vytvoření odběratele s potvrzením úmyslu odběru