Lead Gen & CRM has a distinct API organization. This article will detail the parts of the Lead Gen & CRM API, related to emails.
| Administrators | ✓ | |
| Company Managers | ||
| Marketing Managers | ||
| Sales Managers | ||
| Salespersons | ||
| Jr. Salespersons |
HTML emails created in Lead Gen & CRM.
|
|
Name | Type | Length | Is Required |
| id | int | 18 | Optional | |
| html | text | Required | ||
| emailName | varchar | 255 | Required | |
| subject | varchar | 255 | Required | |
| fromName | varchar | 255 | Required | |
| fromEmail | varchar | 255 | Required | |
| replyTo | varchar | 255 | Optional | |
| unsubCategory | int | 18 | Optional | |
| contactManager | tinyint | 1 | Optional | |
| repeatable | tinyint | 1 | Optional | |
| fromLeadOwner | tinyint | 1 | Optional |
Contains information regarding particular lead's actions with particular emails sent in an email job.
|
|
Name | Type | Length | Is Required |
| leadID | int | 18 | Optional | |
| emailID | int | 18 | Optional | |
| emailJobID | int | 18 | Optional | |
| createDate | timestamp | 255 | Optional | |
| emailAddress | varchar | 150 | Optional |
Associates data of a given jobID with emailIDs and recipientIDs.
|
|
Name | Type | Length | Is Required |
| id | int | 18 | Optional | |
| emailID | int | 18 | Optional | |
| isList | tinyint | 1 | Optional | |
| isActive | tinyint | 1 | Optional | |
| recipientID | int | 18 | Optional | |
| sendCount | int | 18 | Optional | |
| confirmedSend | tinyint | 1 | Optional | |
| allowDuplicates | tinyint | 1 | Optional | |
| createTimestamp | timestamp | 255 | Optional |
Contains information about a group of emails, including the ID, HTML content, subject line, and thumbnail image.
|
|
Name | Type | Length | Is Required |
| id | int | 18 | Optional | |
| createTimestamp | timestamp | 255 | Optional | |
| title | varchar | 255 | Optional | |
| subject | varchar | 255 | Optional | |
| thumbnail | varchar | 255 | Optional |
Contains data about particular email jobs, such as opens, clicks, and unsubscribe metrics.
|
|
Name | Type | Length | Is Required |
| id | int | 18 | Optional | |
| emailID | int | 18 | Optional | |
| workflowID | int | 18 | Optional | |
| sendCount | int | 50 | Optional | |
| statistics | hash | 255 | Optional | |
| domains | hash | 255 | Optional | |
| numUnsubscribeReasons | array | 50 | Optional | |
| uniqueOpens | int | 50 | Optional | |
| uniqueClicks | int | 50 | Optional |
Contains information about actions a lead took with an email job.
|
|
Name | Type | Length | Is Required |
| id | int | 18 | Optional | |
| contactID | int | 18 | Optional | |
| type | varchar | 50 | Optional |
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 | Type | Length | Is Required |
| emailID | int | 18 | Required | |
| listID | int | 18 | Required | |
| listTagID | int | 18 | Required | |
| immediate | tinyint | 1 | Optional | |
| date | date | 255 | Optional | |
| hours | int | 18 | Optional | |
| minutes | int | 18 | Optional | |
| meridiem | varchar | 255 | Optional | |
| sendDuplicate | tinyint | 1 | Optional |
Contains information about email jobs sending in the Schedule Events queue.
|
|
Name | Type | Length | Is Required |
| id | int | 18 | Optional | |
| active | tinyint | 1 | Optional | |
| fromemail | varchar | 150 | Optional | |
| fromname | varchar | 50 | Optional | |
| senddate | timestamp | 255 | Optional | |
| startdate | timestamp | 255 | Optional | |
| subject | varchar | 150 | Optional |
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 | Type | Length | Is Required |
| id | int | 18 | Optional | |
| companyProfileID | int | 18 | Optional | |
| label | varchar | 50 | Optional |
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:
Copyright © 2025 · All Rights Reserved · Constant Contact · Privacy Center