Lead Gen & CRM
How can we help you?
Search our help articles, video tutorials, and quickstart guides

You've got this. You've got us. Search our Knowledge Base to quickly find answers to your questions.

Understanding Lead Gen & CRM Open API Schema: Emails

Article: 000050888
Updated: July 15, 2024

Lead Gen & CRM has a distinct API organization. This article will detail the parts of the Lead Gen & CRM API, related to emails.


Article Contents


Users:
Administrators 
Company Managers  
Marketing Managers  
Sales Managers  
Salespersons  
Jr. Salespersons  


Email

HTML emails created in Lead Gen & CRM.
 

 

Name

TypeLengthIs Required
 idint18Optional
 htmltext Required
 emailNamevarchar255Required
 subject varchar255Required
 fromName varchar255Required
 fromEmail varchar255Required
 replyTo varchar255Optional
 unsubCategory int18Optional
 contactManagertinyint1Optional
 repeatabletinyint1Optional
 fromLeadOwnertinyint1Optional

 



EmailEvent

Contains information regarding particular lead's actions with particular emails sent in an email job.
 

 

Name

TypeLengthIs Required
 leadIDint18Optional
 emailIDint18Optional
 emailJobIDint18Optional
 createDatetimestamp255Optional
 emailAddressvarchar150Optional

 


 

EmailJob

Associates data of a given jobID with emailIDs and recipientIDs.
 

 

Name

TypeLengthIs Required
 idint18Optional
 emailIDint18Optional
 isListtinyint1Optional
 isActivetinyint1Optional
 recipientIDint18Optional
 sendCountint18Optional
 confirmedSendtinyint1Optional
 allowDuplicatestinyint1Optional
 createTimestamptimestamp255Optional

 



EmailListing

Contains information about a group of emails, including the ID, HTML content, subject line, and thumbnail image.
 

 

Name

TypeLengthIs Required
 id int18Optional
 createTimestamptimestamp255Optional
 titlevarchar255Optional
 subjectvarchar255Optional
 thumbnailvarchar255Optional

 



EmailSend

Contains data about particular email jobs, such as opens, clicks, and unsubscribe metrics.
 

 

Name

TypeLengthIs Required
 idint18Optional
 emailIDint18Optional
 workflowIDint18Optional
 sendCountint50Optional
 statisticshash255Optional
 domainshash255Optional
 numUnsubscribeReasonsarray50Optional
 uniqueOpensint50Optional
 uniqueClicksint50Optional

 



EmailSendEvent

Contains information about actions a lead took with an email job.
 

 

Name

TypeLengthIs Required
 idint18Optional
 contactIDint18Optional
 typevarchar50Optional

 


 

ScheduleSend

An email send that is scheduled to be performed in Lead Gen & CRM. A listID or listTagID must be specified. The send must either be scheduled to send immediately, or a date/time must be provided.
 

 

Name

TypeLengthIs Required
 emailIDint18Required
 listIDint18Required
 listTagIDint18Required
 immediatetinyint1Optional
 datedate255Optional
 hoursint18Optional
 minutesint18Optional
 meridiemvarchar255Optional
 sendDuplicatetinyint1Optional

 



ScheduleSendQueue

Contains information about email jobs sending in the Schedule Events queue.
 

 

Name

TypeLengthIs Required
 idint18Optional
 activetinyint1Optional
 fromemailvarchar150Optional
 fromnamevarchar50Optional
 senddatetimestamp255Optional
 startdatetimestamp255Optional
 subjectvarchar150Optional

 



UnsubscribeCategory

Consists of the different email categorizations that Lead Gen & CRM users can label emails with, and also the categories that recipients can choose to unsubscribe from.
 

 

Name

TypeLengthIs Required
 idint18Optional
 companyProfileIDint18Optional
 labelvarchar50Optional

 


 

Additional API Information

This article details specific schema content about Lead Gen & CRM's API. However, given the size and scope of the API, information is broken up and is contained in different articles. Each article focuses on a specific function of Lead Gen & CRM's API. Additional API information can be found in the following articles:

 


Did this article answer your question?


Constant Contact Logo

Copyright © 2025 · All Rights Reserved · Constant Contact · Privacy Center