1. Nápověda
  2. Jak pracovat přes API s sender-solutions.com
  3. 1. Vytvoření odběratele pomocí API

1. Vytvoření odběratele pomocí API

1. Vytvoření odběratele pomocí API

Metoda je určena k vytvoření nového odběratele v projektu. Data se předávají ve formátu application/json.

HTTP požadavek
  • URL: https://sender-solutions.com/api/subscribers/create-subscriber/
  • 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",
        "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"
    }
}
Příklad požadavku s použitím 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"
    }
}'
Popis polí
Pole Typ Povinné 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 v obou polích, 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 v obou polích, přednost má Subscriber.Base.Id.
Subscriber.IsActive boolean Příznak aktivity odběratele. Výchozí hodnota false.
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" — mužské, "female" — ženské, "" (prázdný řetězec) — «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 Uživatelské pole 1. Vyplňte libovolnými informacemi dle vlastního uvážení.
Subscriber.CustomField2 string Uživatelské pole 2. Vyplňte libovolnými informacemi dle vlastního uvážení.
Subscriber.CustomField3 string Uživatelské pole 3. Vyplňte libovolnými informacemi 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
Příklad úspěšné odpovědi. Obsahuje data vytvořeného odběratele ve stejné struktuře jako API požadavek. Rovněž obsahuje doplňkové pole Subscriber.Id — identifikátor vytvořeného odběratele.
{
    "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"
    }
}