Envoyer une campagne e-mail à un groupe

Documentation :

http://webapi.mymarketing.co.il/api/docs/User/Api/POST-api-campaigns

L'exemple ci-dessous est très simplifié (vous pouvez ajouter de nombreux objets, comme un test A/B, des paniers, etc.).

Les paramètres :

  • Scheduling : cet objet est obligatoire. Vous ne pouvez pas envoyer la campagne immédiatement : vous devez la programmer (vous pouvez la programmer quelques secondes plus tard, mais il n'existe pas d'option send now: true comme pour les SMS, par exemple).

  • Pairs (key, value) : expliqué dans un article distinct.

  • Group id : ouvrez le groupe et regardez « ID=NUMÉRO » dans l'URL de la page.

  • Mailing list id : se trouve de la même façon que pour un groupe (à utiliser seulement si le compte a une liste de diffusion).

  • send_test : envoie un e-mail de test.

  • Name : le nom de la campagne dans ActiveTrail.

  • Profile id : présenté dans l'article sur les profils d'envoi, avec des explications et des images qui montrent où le trouver.

  • google_analytics_name : à ajouter pour l'intégration avec Google Analytics. Facultatif.

  • Subject : l'objet (obligatoire).

  • Preheader : le préheader (facultatif).

  • predictive_delivery: true : active l'envoi prédictif si votre compte en dispose. Sinon, retirez-le.

  • Template id : allez dans Campagnes → Mes gabarits, ouvrez le gabarit voulu et regardez « ID=NUMÉRO » dans l'URL de la page.

  • Content : le contenu de la campagne, qui peut contenir du HTML. Ajoutez une barre oblique inverse (\) avant chaque guillemet du code pour éviter les erreurs. Si vous envoyez à la fois content et un gabarit, c'est le gabarit qui est envoyé.

À noter : si vous ajoutez un contenu, le gabarit est inutile, et inversement.

  • content_category_id : nécessaire quand la requête envoie aussi un test : sans test, le point de terminaison fonctionne sans lui ; avec un test et sans ce paramètre, vous recevez une erreur. Si vous gardez la valeur par défaut (1), vous ne pourrez pas dupliquer la campagne.
    Pour obtenir l'ID de la catégorie, contactez le support ActiveTrail.

JSON :

{
  "scheduling": {
    "is_sent": true,
    "scheduled_date_utc": "2023-06-01T10:25:12",
    "is_limit_to_confirmed": true
  },
  "pairs": [
    {
      "Key": "G",
      "Value": "3"
    }
  ],
  "segment": {
    "group_ids": [
      105930
    ]
  },
  "details": {
    "name": "sample string 1",
    "subject": "sample string 2",
    "user_profile_id": 47800,
    "google_analytics_name": "sample string 3",
    "content_category_id": 1,
    "preheader": "sample string 4"
  },
  "design": {
    "content": "sample string 1",
    "language_type": "UTF-8",
    "header_footer_language_type": "UTF-8",
    "is_add_print_email": true,
    "is_auto_css_inliner": true,
    "is_remove_system_links": false
  },
  "template": {
    "id": 109273
  }
}