1. Ajutor
  2. Cum să lucrați prin API cu sender-solutions.com
  3. 1. Crearea unui abonat cu ajutorul API

1. Crearea unui abonat cu ajutorul API

1. Crearea unui abonat cu ajutorul API

Metoda este destinată creării unui nou abonat în proiect. Datele se transmit în formatul application/json.

Cerere HTTP
  • URL: https://sender-solutions.com/api/subscribers/create-subscriber/
  • Metodă HTTP: POST
  • Content-Type: application/json
Corpul cererii (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"
    }
}
Exemplu de cerere cu folosirea 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"
    }
}'
Descrierea câmpurilor
Câmp Tip Obligatoriu Descriere
Subscriber.Base.Id number Identificatorul bazei de abonați. Obligatoriu trebuie indicat acest câmp sau Subscriber.Base.Name. Dacă se transmit valori nevide în ambele câmpuri, prioritatea se acordă lui Subscriber.Base.Id.
Subscriber.Base.Name string Denumirea bazei de abonați. Obligatoriu trebuie indicat acest câmp sau Subscriber.Base.Id. Dacă se transmit valori nevide în ambele câmpuri, prioritatea se acordă lui Subscriber.Base.Id.
Subscriber.IsActive boolean Indicatorul de activitate al abonatului. Implicit false.
Subscriber.Email string Email-ul abonatului
Subscriber.FirstName string Prenume
Subscriber.LastName string Nume de familie
Subscriber.Gender string Sexul abonatului. Valori posibile: "male" — masculin, "female" — feminin, "" (șir gol) — «Neindicat». Implicit — «Neindicat».
Subscriber.Phone string Numărul de telefon
Subscriber.Tags array[string] Etichetele abonatului, array de șiruri
Subscriber.ClientUserId string ID-ul abonatului în sistemul clientului
Subscriber.CustomField1 string Câmp personalizat 1. Completați cu orice informație la discreția voastră.
Subscriber.CustomField2 string Câmp personalizat 2. Completați cu orice informație la discreția voastră.
Subscriber.CustomField3 string Câmp personalizat 3. Completați cu orice informație la discreția voastră.
Subscriber.Address.Country string Codul țării din două caractere (ISO 3166-1 alpha-2)
Subscriber.Address.City string Oraș
Subscriber.Address.State string | null Regiune / stat / provincie
Subscriber.Address.Zip number Cod poștal
Subscriber.Address.Line1 string Linia principală a adresei
Subscriber.Address.Line2 string Linia suplimentară a adresei
Subscriber.Address.Line3 string | null Linia suplimentară a adresei
Subscriber.Birthday string (YYYY-MM-DD) Data nașterii în formatul YYYY-MM-DD
Exemplu de răspuns reușit. Conține datele abonatului creat în aceeași structură ca și cererea API. De asemenea, conține câmpul suplimentar Subscriber.Id — identificatorul abonatului creat.
{
    "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"
    }
}