Sender Solutions | Descrierea cererii API: crearea unui abonat cu confirmarea intenției de abonare

Metoda este destinată creării unui nou abonat în proiect cu confirmarea abonării de către abonatul însuși. Acest lucru este potrivit pentru formularele publice de abonare pe site-uri, unde se poate introduce orice Email. Sistemul Sender Solutions va trimite unui astfel de abonat un e-mail, pentru ca el să confirme separat că vrea să primească campania. Acest lucru va proteja baza de abonați de erorile accidentale sau intenționate la introducerea Email-ului. Datele se transmit în formatul application/json.

Cerere HTTP

URL: https://sender-solutions.com/api/subscribers/subscribe-action/
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",
        "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"
}

Exemplu de cerere cu folosirea 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"
}'

Descrierea câmpurilor

Câmp	Tip	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	Numele 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. După confirmarea abonării, abonatul va fi activ. Puteți ignora acest câmp.
`Subscriber.Email`	string	Email-ul abonatului
`Subscriber.FirstName`	string	Prenume
`Subscriber.LastName`	string	Nume de familie
`Subscriber.Gender`	string	Sexul abonatului. Valori posibile: "male" pentru masculin, "female" pentru feminin, ""(șir gol) pentru valoarea "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 liber 1, completați cu orice informație la discreția voastră.
`Subscriber.CustomField2`	string	Câmp liber 2, completați cu orice informație la discreția voastră.
`Subscriber.CustomField3`	string	Câmp liber 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
`PreferredLanguage`	string	Codul limbii preferate pentru folosirea în e-mailul către abonat în formatul ISO 639-1. Trebuie să conțină 2 litere latine mici (de exemplu: en, uk, ru). Implicit en

Exemplu de răspuns reușit. Primirea unui răspuns reușit înseamnă că abonatului i-a fost trimis un e-mail cu confirmarea abonării. El trebuie să acceseze linkul din e-mail și să confirme intenția de abonare.

{
    "success": true
}

9. Descrierea cererii API: crearea unui abonat cu confirmarea intenției de abonare