1. Aiuto
  2. Come lavorare tramite API con sender-solutions.com
  3. 1. Creazione di un iscritto mediante l'API

1. Creazione di un iscritto mediante l'API

1. Creazione di un iscritto mediante l'API

Il metodo è destinato alla creazione di un nuovo iscritto nel progetto. I dati vengono trasmessi in formato application/json.

Richiesta HTTP
  • URL: https://sender-solutions.com/api/subscribers/create-subscriber/
  • 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",
        "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"
    }
}
Esempio di richiesta usando 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"
    }
}'
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. Per impostazione predefinita false.
Subscriber.Email string Email dell'iscritto
Subscriber.FirstName string Nome
Subscriber.LastName string Cognome
Subscriber.Gender string Sesso dell'iscritto. Valori possibili: "male" — maschile, "female" — femminile, "" (stringa vuota) — «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 personalizzato 1. Compila con qualsiasi informazione a tua discrezione.
Subscriber.CustomField2 string Campo personalizzato 2. Compila con qualsiasi informazione a tua discrezione.
Subscriber.CustomField3 string Campo personalizzato 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
Esempio di risposta riuscita. Contiene i dati dell'iscritto creato nella stessa struttura della richiesta API. Contiene inoltre il campo aggiuntivo Subscriber.Id — identificatore dell'iscritto creato.
{
    "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"
    }
}