Entities / Resources
We currently do not expose all entities in the documentation by choice, we will cover the most common ones here. Please refrain from using undocumented entities (or undocumented attributes) as they will change without notice and will break your integrations.
Please refer to the API Reference to know what capabilities are exposed.
Client /v1/client
Represents a tenant in our multi-tenant software. It is the main entity that owns all other entities like Contacts, Lists, etc.
User /v1/user
Represents a person using the Leadfox application. A User can have multiple Clients and has a Role in each of them which defines what they are allowed to do.
Contact /v1/contact
Represents a person in the Client's marketing database, they are essentially the Client's leads and customers. They are identified by an email address and can have multiple custom Properties.
All Contacts are unique by their email address within a Client. You cannot have two Contacts with the same email address in the same Client.
Property /v1/property
Represents a custom attribute of a Contact. Each Property has a shortcode which is used as the key in the Contact's Properties subdocument. The value of a Property is always stored as a string (text).
List /v1/list
Represents a grouping of Contacts used for emailing and segmentation. Contacts can be added, for example when filling a form on one of our tools like a Page Campaign, Popup Campaign or Form Campaign. They can also be removed, for example when using our Automation system.
MailingList /v1/mailinglist
Represents an email category used for managing GDPR subscriptions. Contacts can opt-in or opt-out of the Client's MailingLists.
A good example of MailingList would be "Newsletter" or "Promotions". A Contact can choose to subscribe to the "Promotions" while opting out of the "Newsletter".
MailingLists are used to manage GDPR compliant subscriptions and should be used in combination with Lists. For example, if you want to send a promotional email to a subset of your whole Contact database, you would use both. The MailingList to ensure compliance (only send to the one that opted-in) while targeting specific Contacts using a curated List that you segmented by hand or via our Automation system.
MailingLists are optional and must be enabled in the Client's settings to be used. If the feature is not enabled, the values are simply ignored when sending emails.
Folder /v1/folder
Represents a collection of various entities like Campaigns and Automations used to organize them inside Leadfox.
Campaign /v1/campaign
Represents our EmailCampaign, PageCampaign, PopupCampaign and FormCampaign entities. Each Campaign type has its own specific schema and behavior (think inheritance). A Campaign needs to reference one or multiple designs and that can be A/B tested (Variants).
Please refer to the various guides and tutorials in the documentation to learn more about creating and using Campaigns.
For now, we only expose EmailCampaigns.
Beware that there is often some confusion around the word "Campaign" in the Leadfox application (UI) and the API.
In the API, a Campaign is a specific entity type like EmailCampaign, PageCampaign, etc. while in the application, a "Campaign" is a container (Folder).
Email /v1/email
Represents an email design used in an EmailCampaign.
Contains the HTML content, subject, from name, from email, etc.