Lead Gen & CRM

How can we help you?

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

Lead Gen & CRM

> Integrations

> API

Understanding Lead Gen & CRM Open API Methods: Email

Article: 000050886

Updated: March 4, 2025

A reference source for Lead Gen & CRM's Email-specific API methods

Lead Gen & CRM has a distinct API organization. This article will detail the methods listed within the Lead Gen & CRM API, related to Email.

Users:

Administrators	✓
Company Managers
Marketing Managers
Sales Managers
Salespersons
Jr. Salespersons

Additional API Information

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:

CreateSendEmail

createSendMail		Sends an email to a list or lists of a specific tag.
Params	Name	Type	Is Required
Params	objects	list<ScheduleSend>	Required

Return Data	Name	Type
Return Data	actions	list<CreateResult>

createEmail

createEmail		Creates an email from HTML.
Params	Name	Type	Is Required
Params	objects	list<Email>	Required

Return Data	Name	Type
Return Data	actions	list<CreateResult>

deleteEmail		Specifies an email ID to be deleted in Lead Gen & CRM.
Params	Name	Type	Is Required
Params	objects	list<id>	Required

Return Data	Name	Type
Return Data	actions	list<DeleteResult>

getEmail		Returns the requested email HTML data.
Params	Name	Type	Is Required
Params	id	int	Required

Return Data	Name	Type
Return Data	fields	Returns just the HTML data

getEmailListing		Returns a list of email information.
Params	Name	Type	Is Required
	where	hash Required: none Optional: id	Optional
	limit	int	Optional
	offset	int	Optional

Return Data	Name	Type
Return Data	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
Params	object	list<Email>	Required

Return Data	Name	Type
Return Data	actions	list<UpdateResult>

EmailJob

deleteScheduleSend		Deletes an email job scheduled to send to a list or a lead.
Params	Name	Type	Is Required
Params	jobID	int	Required

Return Data	Name	Type
Return Data	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
Return Data	events	list<EmailEvent>

getEmailSend		Retrieve all aggregate data for an email job.
Params	Name	Type	Is Required
Params	where	hash Required: sendID Optional: none	Required

Return Data	Name	Type
Return Data	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
Params	sendID	int	Required

Return Data	Name	Type
Return Data	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
Return Data	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
Params	where	hash Required: none Optional: id, campaignName	Required

Return Data	Name	Type
Return Data	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
Return Data	sendCounts	list<companyID, sendCount>

Unsubscribe Category

getUnsubscribeCategories		Gets a list of unsubscribe categories.
Params	Name	Type	Is Required
Params	none		Optional

Return Data	Name	Type
Return Data	getAllUnsubscribeCategories	list<UnsubscribeCategory>

getemailjob

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
Return Data	getAllgetEmailJobs	list<EmailJob>

Did this article answer your question?

Yes

Partially

Choose your product

topic label

topic title

View More

subtopic title

View More

Video Tutorials

subtopic name

article title

QuickStart Guides

title

What's New

Latest Product Updates

Understanding Lead Gen & CRM Open API Methods: Email

A reference source for Lead Gen & CRM's Email-specific API methods

Article Contents

Additional API Information

CreateSendEmail

createSendMail

createEmail

createEmail

deleteEmail

getEmail

getEmailListing

updateEmail

EmailJob

deleteScheduleSend

getEmailEvents

getEmailSend

getEmailSendEvents

getEmailSendStatus

getScheduleSendStatus

getScheduleSends

getSendCount

Unsubscribe Category

getUnsubscribeCategories

getemailjob

getEmailJobs

Questions?

Did this article answer your question?

Related Answers