1. Hilfe
  2. Wie man über die API mit sender-solutions.com arbeitet
  3. 1. Erstellen eines Abonnenten mithilfe der API

1. Erstellen eines Abonnenten mithilfe der API

1. Erstellen eines Abonnenten mithilfe der API

Die Methode ist zum Erstellen eines neuen Abonnenten im Projekt vorgesehen. Die Daten werden im Format application/json übergeben.

HTTP-Anfrage
  • URL: https://sender-solutions.com/api/subscribers/create-subscriber/
  • 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",
        "Gender": "male",
        "Phone": "+380111222333",
        "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
        },
        "Birthday": "2002-04-15"
    }
}
Beispiel einer Anfrage unter Verwendung von cURL

curl --location 'https://sender-solutions.com/api/subscribers/create-subscriber/' \
--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",
        "Gender": "male",
        "Phone": "+380111222333",
        "Tags": ["api", "test-user"],
        "ClientUserId": "ClientUserId12345",
        "CustomField1": "CustomValue1",
        "CustomField2": "CustomValue2",
        "CustomField3": "CustomValue3",
        "Address": {
            "Country": "UA",
            "City": "Odesa",
            "State": null,
            "Zip": 65000,
            "Line1": "Very Long street",
            "Line2": "building 42",
            "Line3": null
        },
        "Birthday": "2002-04-15"
    }
}'
Beschreibung der Felder
Feld Typ Obligatorisch Beschreibung
Subscriber.Base.Id number Kennung der Abonnentenbasis. Dieses Feld oder Subscriber.Base.Name muss zwingend angegeben werden. Wenn in beiden Feldern 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 beiden Feldern nicht leere Werte übergeben werden, wird Subscriber.Base.Id der Vorrang gegeben.
Subscriber.IsActive boolean Aktivitäts-Flag des Abonnenten. Standardmäßig false.
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" — männlich, "female" — weiblich, "" (leere Zeichenkette) — «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 Benutzerdefiniertes Feld 1. Füllen Sie es mit beliebigen Informationen nach eigenem Ermessen aus.
Subscriber.CustomField2 string Benutzerdefiniertes Feld 2. Füllen Sie es mit beliebigen Informationen nach eigenem Ermessen aus.
Subscriber.CustomField3 string Benutzerdefiniertes Feld 3. Füllen Sie es mit beliebigen 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
Beispiel einer erfolgreichen Antwort. Enthält die Daten des erstellten Abonnenten in derselben Struktur wie die API-Anfrage. Enthält außerdem das zusätzliche Feld Subscriber.Id — die Kennung des erstellten Abonnenten.
{
    "success": true,
    "Subscriber": {
        "Id": 24,
        "Base": {
            "Id": 13,
            "Name": "Test Users"
        },
        "IsActive": true,
        "Email": "username@example.com",
        "FirstName": "Cat",
        "LastName": "Catstone",
        "Gender": "male",
        "Phone": "+380111222333",
        "Tags": [
            "api",
            "test-user"
        ],
        "ClientUserId": "ClientUserId12345",
        "CustomField1": "CustomValue1",
        "CustomField2": "CustomValue2",
        "CustomField3": "CustomValue3",
        "Address": {
            "Country": "UA",
            "City": "Odesa",
            "State": "",
            "Zip": "65000",
            "Line1": "Very Long street",
            "Line2": "building 42",
            "Line3": ""
        },
        "Birthday": "2002-04-15"
    }
}