1. Aide
  2. Comment travailler via l'API avec sender-solutions.com
  3. 9. Description de la requête API : création d'un abonné avec confirmation de l'intention d'abonnement

9. Description de la requête API : création d'un abonné avec confirmation de l'intention d'abonnement

9. Description de la requête API : création d'un abonné avec confirmation de l'intention d'abonnement

La méthode est destinée à la création d'un nouvel abonné dans le projet avec confirmation de l'abonnement par l'abonné lui-même. Cela convient bien aux formulaires d'abonnement publics sur les sites web, où l'on peut saisir n'importe quel Email. Le système Sender Solutions enverra à un tel abonné un e-mail pour qu'il confirme séparément qu'il souhaite recevoir l'envoi. Cela protégera la base d'abonnés contre les erreurs accidentelles ou intentionnelles lors de la saisie de l'Email. Les données sont transmises au format application/json.

Requête HTTP
  • URL : https://sender-solutions.com/api/subscribers/subscribe-action/
  • 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",
        "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"
}
Exemple de requête à l'aide de 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"
}'
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é. Après la confirmation de l'abonnement, l'abonné sera actif. Ce champ peut être ignoré.
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" pour masculin, "female" pour féminin, ""(chaîne vide) pour la valeur "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 libre 1, remplissez avec n'importe quelle information à votre discrétion.
Subscriber.CustomField2 string Champ libre 2, remplissez avec n'importe quelle information à votre discrétion.
Subscriber.CustomField3 string Champ libre 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
PreferredLanguage string Code de la langue préférée à utiliser dans l'e-mail à l'abonné au format ISO 639-1. Doit contenir 2 lettres latines minuscules (par exemple : en, uk, ru). Par défaut en
Exemple de réponse réussie. L'obtention d'une réponse réussie signifie qu'un e-mail avec la confirmation de l'abonnement a été envoyé à l'abonné. Il doit suivre le lien de l'e-mail et confirmer l'intention d'abonnement.
{
    "success": true
}