4. Envoi d'un abonné vers une Campagne d'envoi via l'API

La méthode est destinée à l'envoi par déclencheur d'un Abonné existant vers une Campagne d'envoi existante. Les données sont transmises au format application/json.

Requête HTTP
  • URL : https://sender-solutions.com/api/subscribers/send-subscriber-into-campaign/
  • Méthode HTTP : POST
  • Content-Type : application/json
Corps de la requête (JSON)
{
    "SendIntoCampaign": {
        "SubscriberId": 21,
        "CampaignId": 5,
        "Variables": {
            "myVar1": "myVar1 value",
            "myVar2": {
                "option1": "myVar2 option value"
            }
        }
    }
}
Exemple de requête à l'aide de cURL

curl --location 'https://sender-solutions.com/api/subscribers/send-subscriber-into-campaign/' \
--header 'Content-Type: application/json' \
--header 'Authorization: {{api-token}}' \
--data '{
    "SendIntoCampaign": {
        "SubscriberId": 21,
        "CampaignId": 5,
        "Variables": {
            "myVar1": "myVar1 value",
            "myVar2": {
                "option1": "myVar2 option value"
            }
        }
    }
}'
Description des champs
Champ Type Obligatoire Description
SendIntoCampaign.SubscriberId number Identifiant de l'abonné
SendIntoCampaign.CampaignId number Identifiant de la campagne d'envoi
SendIntoCampaign.Variables array Variables supplémentaires à transmettre au modèle de l'e-mail. C'est un objet à structure arbitraire, où les clés (noms des propriétés) du premier niveau sont des variables qui seront disponibles dans le modèle. Les noms des variables ne doivent pas coïncider avec ceux disponibles dans le modèle au niveau du système, par exemple subscriber
Exemple de réponse réussie
{
    "success": true,
    "SendIntoCampaign": {
        "SendMessageRequestId": 41,
        "SubscriberId": 21,
        "CampaignId": 5,
        "MessageId": "kidabt3j31mo6vp611gx2yfpo4zr1a5c@sender-solutions.com"
    }
}

Dans le corps de la réponse, le champ SendIntoCampaign.SendMessageRequestId correspond à l'identifiant unique de la tâche d'envoi d'un e-mail. Le champ SendIntoCampaign.MessageId correspond à la valeur unique de l'en-tête Message-ID de l'e-mail.
Ces données peuvent être utiles pour exécuter d'autres requêtes vers notre API ou lors du contact avec le support technique.