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

Article: 000050887
Updated: July 9, 2024

Reference source for Lead Gen & CRM's Opportunity-specific API schema

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


Article Contents


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

 

Opportunity

An opportunity represents a potential deal that has an expected value. An opportunity can be associated with a lead or account, as well as a campaign.
 

 

Name

TypeLengthIs Required
 idint18Optional
 ownerIDint18Required
 dealStageIDint18Required
 accountID int18Optional
 campaignIDint18Optional
 opportunityName varchar255Required
 probability double18Optional
 amountdouble18Optional
 isClosed tinyint1Optional
 isWon tinyint Optional
 isActive tinyint1Optional
 closeDate timestamp255Required
 originatingLeadIDint18Optional
 primaryLeadID int18Optional

 



OpportunityLead

A mapping table that represents an association between an opportunity and lead. Each opportunity in Lead Gen & CRM can consist of multiple leads.
 

 

Name

TypeLengthIs Required
 idint18Optional
 opportunityIDint18Required
 leadIDint18Required

 


 

DealStage

A deal stage is a custom state for your opportunity pipeline. As opportunities progress, the deal stage is changed until the opportunity is finally won or lost.
 

 

Name

TypeLengthIs Required
 idint18Optional
 dealStageNamevarchar255Required
 descriptionvarchar255Optional
 defaultProbabilitydouble18Optional
 weightint18Optional
 isEditabletinyint1Optional

 



Field

Contains metadata for a Lead Gen & CRM field. This includes both lead and opportunity fields. The systemName is a key that can be specified in any POST to create or update an object.
 

 

Name

TypeLengthIs Required
 idint18Optional
 relationshipvarchar255Required
 systemNamevarchar255Optional
 labelvarchar255Required
 sourcevarchar255Optional
 dataTypevarchar255Required
 dataLengthint18Required
 isRequiredtinyint1Required
 isCustomtinyint1Required
 isActivetinyint1Required
 isAvailableInContactManagertinyint1Required
 isEditableInContactManagertinyint1Required
 isAvailableInFormstinyint1Required

 


 

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