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: Opportunities

Article: 000050893

Updated: July 15, 2024

Lead Gen & CRM has a distinct API organization.

This article will detail the methods listed within the Lead Gen & CRM API, related to Opportunities.

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:

DealStage

createDealStages		Specifies a list of DealStage objects to be created in Lead Gen & CRM.
Params	Name	Type	Is Required
Params	objects	list<dealStage>	Required

Return Data	Name	Type
Return Data	creates	list<createResult>

deleteDealStages		Specifies a list of DealStage IDs to be deleted in Lead Gen & CRM.
Params	Name	Type	Is Required
Params	objects	list<id>	Required

Return Data	Name	Type
Return Data	deletes	list<deleteResult>

getDealStage		Retrieves a single DealStage by its ID.
Params	Name	Type	Is Required
Params	id	int	Required

Return Data	Name	Type
Return Data	dealStages	list<DealStage>

getDealStages		Retrieves a list of DealStage objects given a WHERE clause, or retrieves all DealStage objects if WHERE clause is empty.
Params	Name	Type	Is Required
	where	hash Required: none Optional: id	Required
	limit	int	Optional
	offset	int	Optional

Return Data	Name	Type
Return Data	dealStages	list<DealStage>

getDealStagesDateRange		Retrieves a list of DealStages that have been either created or updated between two timestamps. Timestamps must be specified in Y-m-d H:i:s format.
Params	Name	Type	Is Required
	startDate	timestamp	Required
	endDate	timestamp	Required
	timestamp	string Required: create, update Optional: none	Required

Return Data	Name	Type
Return Data	DealStages	list<DealStage>

Opportunity

createOpportunities		Specifies a list of Opportunity objects to be created in Lead Gen & CRM.
Params	Name	Type	Is Required
Params	objects	list<opportunity>	Required

Return Data	Name	Type
Return Data	creates	list<createResult>

deleteOpportunities		Specifies a list of Opportunity IDs to be deleted in Lead Gen & CRM.
Params	Name	Type	Is Required
Params	objects	list<id>	Required

Return Data	Name	Type
Return Data	deletes	list<deleteResult>

getOpportunities		Retrieves a list of Opportunities given a WHERE clause, or retrieves all Opportunities if WHERE clause is empty.
Params	Name	Type	Is Required
	where	hash Required: none Optional: id, ownerID, dealStageID, accountID, campaignID	Required
	limit	int	Optional
	offset	int	Optional

Return Data	Name	Type

	opportunity	list<Opportunity>

getOpportunitiesDateRange		Retrieves a list of Opportunities that have been either created or updated between two timestamps. Timestamps must be specified in Y-m-d H:i:s format.
Params	Name	Type	Is Required
	startDate	timestamp	Required
	endDate	timestamp	Required
	timestamp	string Required: create, update Optional: none	Required

Return Data	Name	Type
Return Data	opportunity	list<Opportunity>

getOpportunity		Retrieves a single Opportunity by its ID.
Params	Name	Type	Is Required
Params	id	int	Required

Return Data	Name	Type
Return Data	opportunities	list<Opportunity>

updateOpportunities		Specifies a list of Opportunity objects to be updated in Lead Gen & CRM.
Params	Name	Type	Is Required
Params	objects	list<opportunity>	Required

Return Data	Name	Type
Return Data	updates	list<updateResult>

OpportunityLead

createOpportunityLeads		Specifies a list of OpportunityLead objects to be created in Lead Gen & CRM.
Params	Name	Type	Is Required
Params	objects	list<OpportunityLead>	Required

Return Data	Name	Type
Return Data	creates	list<createResult>

deleteOpportunityLeads		Specifies a list of OpportunityLead IDs to be deleted in Lead Gen & CRM.
Params	Name	Type	Is Required
Params	objects	list<id>	Required

Return Data	Name	Type
Return Data	deletes	list<deleteResult>

getOpportunityLead		Retrieves a single OpportunityLead by its ID.
Params	Name	Type	Is Required
Params	id	int	Required

Return Data	Name	Type
Return Data	opportunityLeads	list<OpportunityLead>

getOpportunityLeads		Retrieves a list of OpportunityLead objects given a WHERE clause, or retrieves all OpportunityLead objects if WHERE clause is empty.
Params	Name	Type	Is Required
	where	hash Required: none Optional: id, leadID, opportunityID	Required
	limit	int	Optional
	offset	int	Optional

Return Data	Name	Type
Return Data	opportunityLeads	list<OpportunityLeads>

getOpportunityLeadsDateRange		Retrieves a list of OpportunityLeads that have been either created or updated between two timestamps. Timestamps must be specified in Y-m-d H:i:s format.
Params	Name	Type	Is Required
	startDate	timestamp	Required
	endDate	timestamp	Required
	timestamp	string Required: create, update Optional: none	Required

Return Data	Name	Type
Return Data	OpportunityLeads	list<OpportunityLead>

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: Opportunities

Article Contents

Additional API Information

DealStage

createDealStages

deleteDealStages

getDealStage

getDealStages

getDealStagesDateRange

Opportunity

createOpportunities

deleteOpportunities

getOpportunities

getOpportunitiesDateRange

getOpportunity

updateOpportunities

OpportunityLead

createOpportunityLeads

deleteOpportunityLeads

getOpportunityLead

getOpportunityLeads

getOpportunityLeadsDateRange

Questions?

Did this article answer your question?

Related Answers