Entités / Ressources
Par choix, nous n'exposons pas toutes les entités dans la documentation ; nous couvrons ici les plus courantes. Évitez d'utiliser des entités (ou des attributs) non documentés : ils changeront sans préavis et briseront vos intégrations.
Consultez la référence API pour connaître les capacités exposées.
Client /v1/client
Représente un tenant de notre logiciel multi-tenant. C'est l'entité principale, propriétaire de toutes les autres comme les Contacts, les Lists, etc.
User /v1/user
Représente une personne qui utilise l'application Leadfox. Un User peut avoir plusieurs Clients et possède un Role dans chacun d'eux, qui définit ce qu'il a le droit de faire.
Contact /v1/contact
Représente une personne dans la base de données marketing du Client ; essentiellement ses leads et ses clients. Un Contact est identifié par une adresse email et peut avoir plusieurs Properties personnalisées.
Tous les Contacts sont uniques par adresse email au sein d'un Client. Vous ne pouvez pas avoir deux Contacts avec la même adresse email dans le même Client.
Property /v1/property
Représente un attribut personnalisé d'un Contact. Chaque Property a un shortcode qui sert de clé dans le sous-document Properties du Contact. La valeur d'une Property est toujours stockée sous forme de chaîne (texte).
List /v1/list
Représente un regroupement de Contacts utilisé pour l'envoi d'emails et la segmentation. Des Contacts peuvent y être ajoutés, par exemple en remplissant un formulaire sur l'un de nos outils comme une Page Campaign, une Popup Campaign ou une Form Campaign. Ils peuvent aussi en être retirés, par exemple via notre système d'Automation.
MailingList /v1/mailinglist
Représente une catégorie d'emails utilisée pour gérer les abonnements conformes au RGPD. Les Contacts peuvent faire un opt-in ou un opt-out sur les MailingLists du Client.
Un bon exemple de MailingList serait « Newsletter » ou « Promotions ». Un Contact peut choisir de s'abonner aux « Promotions » tout en se désabonnant de la « Newsletter ».
Les MailingLists servent à gérer des abonnements conformes au RGPD et devraient être combinées aux Lists. Par exemple, pour envoyer un email promotionnel à un sous-ensemble de votre base de Contacts, vous utilisez les deux : la MailingList pour la conformité (n'envoyer qu'à ceux qui ont fait un opt-in) et une List ciblée, segmentée à la main ou via notre système d'Automation, pour viser des Contacts précis.
Les MailingLists sont optionnelles et doivent être activées dans les paramètres du Client pour être utilisées. Si la fonctionnalité n'est pas activée, les valeurs sont simplement ignorées lors des envois.
Folder /v1/folder
Représente une collection d'entités variées comme des Campaigns et des Automations, utilisée pour les organiser dans Leadfox.
Campaign /v1/campaign
Représente nos entités EmailCampaign, PageCampaign, PopupCampaign et FormCampaign. Chaque type de Campaign a son propre schéma et son propre comportement (pensez héritage). Une Campaign doit référencer un ou plusieurs designs, qui peuvent faire l'objet de tests A/B (Variants).
Consultez les différents guides et tutoriels de la documentation pour en savoir plus sur la création et l'utilisation des Campaigns.
Pour le moment, nous n'exposons que les EmailCampaigns.
Le mot « Campaign » prête souvent à confusion entre l'application Leadfox (UI) et l'API.
Dans l'API, une Campaign est un type d'entité précis comme EmailCampaign, PageCampaign, etc., alors que dans l'application, une « Campagne » est un conteneur (Folder).
Email /v1/email
Représente un design d'email utilisé dans une EmailCampaign.
Contient le contenu HTML, le sujet, le nom et l'adresse d'expéditeur, etc.