Lead Gen & CRM has a distinct API organization. This article will detail the methods listed within the Lead Gen & CRM API, related to Email.
Administrators | ✓ | |
Company Managers | ||
Marketing Managers | ||
Sales Managers | ||
Salespersons | ||
Jr. Salespersons |
This article provides specific method 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:
createSendMail | Sends an email to a list or lists of a specific tag. | |||||
Params | Name | Type | Is Required | |||
objects | list<ScheduleSend> |
Required | ||||
Return Data | Name | Type | ||||
actions |
list<CreateResult> |
createEmail | Creates an email from HTML. | |||||
Params | Name | Type | Is Required | |||
objects | list<Email> |
Required | ||||
Return Data | Name | Type | ||||
actions |
list<CreateResult> |
deleteEmail | Specifies an email ID to be deleted in Lead Gen & CRM. | |||||
Params | Name | Type | Is Required | |||
objects | list<id> | Required | ||||
Return Data | Name | Type | ||||
actions | list<DeleteResult> |
getEmail | Returns the requested email HTML data. | |||||
Params | Name | Type | Is Required | |||
id |
int | Required | ||||
Return Data | Name | Type | ||||
fields |
Returns just the HTML data |
getEmailListing | Returns a list of email information. | |||||
Params | Name | Type | Is Required | |||
where |
hash | Optional | ||||
limit |
int | Optional | ||||
offset |
int | Optional | ||||
Return Data | Name | Type | ||||
fields |
list<emailListing> |
updateEmail | Specifies a list of existing Emails to be updated in Lead Gen & CRM. The ID of each email must be passed for each record being updated. | |||||
Params | Name | Type | Is Required | |||
object |
list<Email> | Required | ||||
Return Data | Name | Type | ||||
actions |
list<UpdateResult> |
deleteScheduleSend | Deletes an email job scheduled to send to a list or a lead. | |||||
Params | Name | Type | Is Required | |||
jobID | int | Required | ||||
Return Data | Name | Type | ||||
deletes |
list<DeleteResult> |
getEmailEvents | Retrieves email statistics by jobID. Optionally filter to event type. Allowed values for eventType are clicks, opens, bounces, sends, and unsubscribes. | |||||
Params | Name | Type | Is Required | |||
emailJobID | int | Required | ||||
eventType | string | Required | ||||
Return Data | Name | Type | ||||
events | list<EmailEvent> |
getEmailSend | Retrieve all aggregate data for an email job. | |||||
Params | Name | Type | Is Required | |||
where |
hash | Required | ||||
Return Data | Name | Type | ||||
EmailSend |
list<EmailSend> |
getEmailSendEvents | Retrieves email sends for a given email job. | |||||
Params | Name | Type | Is Required | |||
sendID | int | Required | ||||
eventType |
string [sends, opens, clicks, bounces, spam, unsubscribes] | Required | ||||
limit |
int | Required | ||||
startingAfter |
int [eventID] | Optional | ||||
Return Data | Name | Type | ||||
events | list<EmailSendEvent> | |||||
hasMore | boolean |
getEmailSendStatus | Retrieves a status determining whether an email job has been sent or is in queue. | |||||
Params | Name | Type | Is Required | |||
sendID | int | Required | ||||
Return Data | Name | Type | ||||
status | n/a |
getScheduleSendStatus | Retrieves the send status of a scheduled email job. | |||||
Params | Name | Type | Is Required | |||
jobID | int | Required | ||||
limit | int | Optional | ||||
offset | int | Optional | ||||
Return Data | Name | Type | ||||
automationEventQueue |
id, taskID, workflowID, timeProcessed, processed, workflowEventData, sendDuplicate, email {id, companyID, fromEmail, fromName, subject, title}, whoID, whoType, whatID, whatType, createTimestamp |
getScheduleSends | Retrieves email jobs scheduled to send by list, lead, email, or job. | |||||
Params | Name | Type | Is Required | |||
where |
hash | Required | ||||
Return Data | Name | Type | ||||
sends | list<ScheduleSendQueue> |
getSendCount | Retrieves email send counts by date range and companyID for agency and client accounts. | |||||
Params | Name | Type | Is Required | |||
fromDate | timestamp | Required | ||||
toDate | timestamp | Required | ||||
companyID | int | Optional | ||||
Return Data | Name | Type | ||||
sendCounts |
list<companyID, sendCount> |
getUnsubscribeCategories | Gets a list of unsubscribe categories. | |||||
Params | Name | Type | Is Required | |||
none | Optional | |||||
Return Data | Name | Type | ||||
getAllUnsubscribeCategories |
list<UnsubscribeCategory> |
getEmailJobs | Gets a list of active email jobs for the current account. | |||||
Params | Name | Type | Is Required | |||
limit |
string | Optional | ||||
offset |
string | Optional | ||||
Return Data | Name | Type | ||||
getAllgetEmailJobs |
list<EmailJob> |
Copyright © 2025 · All Rights Reserved · Constant Contact · Privacy Center