1. Aide
  2. Comment travailler via l'API avec sender-solutions.com
  3. 1. Création d'un abonné à l'aide de l'API

1. Création d'un abonné à l'aide de l'API

1. Création d'un abonné à l'aide de l'API

La méthode est destinée à la création d'un nouvel abonné dans le projet. Les données sont transmises au format application/json.

Requête HTTP
  • URL : https://sender-solutions.com/api/subscribers/create-subscriber/
  • Méthode HTTP : POST
  • Content-Type : application/json
Corps de la requête (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"
    }
}
Exemple de requête à l'aide de 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"
    }
}'
Description des champs
Champ Type Obligatoire Description
Subscriber.Base.Id number Identifiant de la base d'abonnés. Ce champ ou Subscriber.Base.Name doit obligatoirement être indiqué. Si des valeurs non vides sont transmises dans les deux champs, la priorité est donnée à Subscriber.Base.Id.
Subscriber.Base.Name string Nom de la base d'abonnés. Ce champ ou Subscriber.Base.Id doit obligatoirement être indiqué. Si des valeurs non vides sont transmises dans les deux champs, la priorité est donnée à Subscriber.Base.Id.
Subscriber.IsActive boolean Indicateur d'activité de l'abonné. Par défaut false.
Subscriber.Email string Email de l'abonné
Subscriber.FirstName string Prénom
Subscriber.LastName string Nom de famille
Subscriber.Gender string Sexe de l'abonné. Valeurs possibles : "male" — masculin, "female" — féminin, "" (chaîne vide) — «Non indiqué». Par défaut — «Non indiqué».
Subscriber.Phone string Numéro de téléphone
Subscriber.Tags array[string] Tags de l'abonné, tableau de chaînes
Subscriber.ClientUserId string ID de l'abonné dans le système du client
Subscriber.CustomField1 string Champ personnalisé 1. Remplissez avec n'importe quelle information à votre discrétion.
Subscriber.CustomField2 string Champ personnalisé 2. Remplissez avec n'importe quelle information à votre discrétion.
Subscriber.CustomField3 string Champ personnalisé 3. Remplissez avec n'importe quelle information à votre discrétion.
Subscriber.Address.Country string Code du pays à deux caractères (ISO 3166-1 alpha-2)
Subscriber.Address.City string Ville
Subscriber.Address.State string | null Région / état / province
Subscriber.Address.Zip number Code postal
Subscriber.Address.Line1 string Ligne principale de l'adresse
Subscriber.Address.Line2 string Ligne supplémentaire de l'adresse
Subscriber.Address.Line3 string | null Ligne supplémentaire de l'adresse
Subscriber.Birthday string (YYYY-MM-DD) Date de naissance au format YYYY-MM-DD
Exemple de réponse réussie. Contient les données de l'abonné créé dans la même structure que la requête API. Contient également le champ supplémentaire Subscriber.Id — identifiant de l'abonné créé.
{
    "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"
    }
}