1. Aiuto
  2. Come lavorare tramite API con sender-solutions.com
  3. 9. Descrizione della richiesta API: creazione di un iscritto con conferma dell'intenzione di iscrizione

9. Descrizione della richiesta API: creazione di un iscritto con conferma dell'intenzione di iscrizione

9. Descrizione della richiesta API: creazione di un iscritto con conferma dell'intenzione di iscrizione

Il metodo è destinato alla creazione di un nuovo iscritto nel progetto con conferma dell'iscrizione da parte dell'iscritto stesso. Questo si adatta bene ai moduli di iscrizione pubblici sui siti web, dove si può inserire qualsiasi Email. Il sistema Sender Solutions invierà a tale iscritto un'email affinché confermi separatamente di voler ricevere l'invio. Questo proteggerà la base di iscritti da errori accidentali o intenzionali durante l'inserimento dell'Email. I dati vengono trasmessi in formato application/json.

Richiesta HTTP
  • URL: https://sender-solutions.com/api/subscribers/subscribe-action/
  • Metodo HTTP: POST
  • Content-Type: application/json
Corpo della richiesta (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"
}
Esempio di richiesta usando 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"
}'
Descrizione dei campi
Campo Tipo Obbligatorio Descrizione
Subscriber.Base.Id number Identificatore della Base di iscritti. Deve essere indicato obbligatoriamente questo campo o Subscriber.Base.Name. Se si trasmettono valori non vuoti in entrambi i campi, la priorità è data a Subscriber.Base.Id
Subscriber.Base.Name string Nome della Base di iscritti. Deve essere indicato obbligatoriamente questo campo o Subscriber.Base.Id. Se si trasmettono valori non vuoti in entrambi i campi, la priorità è data a Subscriber.Base.Id
Subscriber.IsActive boolean Flag di attività dell'iscritto. Dopo la conferma dell'iscrizione, l'iscritto sarà attivo. Questo campo può essere ignorato.
Subscriber.Email string Email dell'iscritto
Subscriber.FirstName string Nome
Subscriber.LastName string Cognome
Subscriber.Gender string Sesso dell'iscritto. Valori possibili: "male" per maschile, "female" per femminile, ""(stringa vuota) per il valore "Non indicato". Per impostazione predefinita "Non indicato"
Subscriber.Phone string Numero di telefono
Subscriber.Tags array[string] Tag dell'iscritto, array di stringhe
Subscriber.ClientUserId string ID dell'iscritto nel sistema del cliente
Subscriber.CustomField1 string Campo libero 1, compila con qualsiasi informazione a tua discrezione.
Subscriber.CustomField2 string Campo libero 2, compila con qualsiasi informazione a tua discrezione.
Subscriber.CustomField3 string Campo libero 3, compila con qualsiasi informazione a tua discrezione.
Subscriber.Address.Country string Codice del paese di due caratteri (ISO 3166-1 alpha-2)
Subscriber.Address.City string Città
Subscriber.Address.State string | null Regione / stato / provincia
Subscriber.Address.Zip number Codice postale
Subscriber.Address.Line1 string Riga principale dell'indirizzo
Subscriber.Address.Line2 string Riga aggiuntiva dell'indirizzo
Subscriber.Address.Line3 string | null Riga aggiuntiva dell'indirizzo
Subscriber.Birthday string (YYYY-MM-DD) Data di nascita in formato YYYY-MM-DD
PreferredLanguage string Codice della lingua preferita da usare nell'email all'iscritto in formato ISO 639-1. Deve contenere 2 lettere latine minuscole (ad esempio: en, uk, ru). Per impostazione predefinita en
Esempio di risposta riuscita. La ricezione di una risposta riuscita significa che all'iscritto è stata inviata un'email con la conferma dell'iscrizione. Deve seguire il link dell'email e confermare l'intenzione di iscrizione.
{
    "success": true
}