Sender Solutions | Beschreibung der API-Anfrage: Erstellen eines Abonnenten mit Bestätigung der Abonnementabsicht

Die Methode ist zum Erstellen eines neuen Abonnenten im Projekt mit Bestätigung des Abonnements durch den Abonnenten selbst vorgesehen. Das eignet sich gut für öffentliche Abonnementformulare auf Websites, wo eine beliebige E-Mail eingegeben werden kann. Das System Sender Solutions sendet einem solchen Abonnenten eine E-Mail, damit er gesondert bestätigt, dass er die Aussendung erhalten möchte. Das schützt die Abonnentenbasis vor zufälligen oder absichtlichen Fehlern bei der Eingabe der E-Mail. Die Daten werden im Format application/json übergeben.

HTTP-Anfrage

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

Anfragetext (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"
}

Beispiel einer Anfrage unter Verwendung von 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"
}'

Beschreibung der Felder

Feld	Typ	Beschreibung
`Subscriber.Base.Id`	number	Kennung der Abonnentenbasis. Dieses Feld oder Subscriber.Base.Name muss zwingend angegeben werden. Wenn in beide Felder nicht leere Werte übergeben werden, wird Subscriber.Base.Id der Vorrang gegeben
`Subscriber.Base.Name`	string	Name der Abonnentenbasis. Dieses Feld oder Subscriber.Base.Id muss zwingend angegeben werden. Wenn in beide Felder nicht leere Werte übergeben werden, wird Subscriber.Base.Id der Vorrang gegeben
`Subscriber.IsActive`	boolean	Aktivitäts-Flag des Abonnenten. Nach der Bestätigung des Abonnements wird der Abonnent aktiv sein. Dieses Feld kann ignoriert werden.
`Subscriber.Email`	string	E-Mail des Abonnenten
`Subscriber.FirstName`	string	Vorname
`Subscriber.LastName`	string	Nachname
`Subscriber.Gender`	string	Geschlecht des Abonnenten. Mögliche Werte: "male" für männlich, "female" für weiblich, ""(leere Zeichenkette) für den Wert "Nicht angegeben". Standardmäßig "Nicht angegeben"
`Subscriber.Phone`	string	Telefonnummer
`Subscriber.Tags`	array[string]	Tags des Abonnenten, Array von Zeichenketten
`Subscriber.ClientUserId`	string	ID des Abonnenten im System des Kunden
`Subscriber.CustomField1`	string	Freies Feld 1, füllen Sie beliebige Informationen nach eigenem Ermessen aus.
`Subscriber.CustomField2`	string	Freies Feld 2, füllen Sie beliebige Informationen nach eigenem Ermessen aus.
`Subscriber.CustomField3`	string	Freies Feld 3, füllen Sie beliebige Informationen nach eigenem Ermessen aus.
`Subscriber.Address.Country`	string	Zweistelliger Ländercode (ISO 3166-1 alpha-2)
`Subscriber.Address.City`	string	Stadt
`Subscriber.Address.State`	string \| null	Region / Staat / Gebiet
`Subscriber.Address.Zip`	number	Postleitzahl
`Subscriber.Address.Line1`	string	Hauptadresszeile
`Subscriber.Address.Line2`	string	Zusätzliche Adresszeile
`Subscriber.Address.Line3`	string \| null	Zusätzliche Adresszeile
`Subscriber.Birthday`	string (YYYY-MM-DD)	Geburtsdatum im Format YYYY-MM-DD
`PreferredLanguage`	string	Code der bevorzugten Sprache zur Verwendung in der E-Mail an den Abonnenten im Format ISO 639-1. Muss 2 kleine lateinische Buchstaben enthalten (zum Beispiel: en, uk, ru). Standardmäßig en

Beispiel einer erfolgreichen Antwort. Der Erhalt einer erfolgreichen Antwort bedeutet, dass dem Abonnenten eine E-Mail mit der Bestätigung des Abonnements gesendet wurde. Er muss dem Link aus der E-Mail folgen und die Abonnementabsicht bestätigen.

{
    "success": true
}

9. Beschreibung der API-Anfrage: Erstellen eines Abonnenten mit Bestätigung der Abonnementabsicht