Opportunities

Opportunities allow you to keep your enquiries and potential customers data in single place, add their contact details, add data about the services they are interested at, the deal size and the status of the conversation.

The API allows you to create, delete, and update your opportunity records. You can retrieve individual opportunities as well as a list of all your opportunities or filter them by status.

Here is the list of all properties the lead object has:

Lead

Property	Type	Required	Description
name	string	true	The full name of the opportunity.
member	Member	true	The _id of the member associated with the opportunity. Either a member or a team is necessary to create a opportunity.
team	Company	true	The _id of the team associated with the opportunity. Either a member or a team is necessary to create a opportunity.
startDate	date	false	The start date of the opportunity.
leadStatus	object	false	Object containing details on the status of the opportunity. The default statuses are lost/open/won. When POST-ing a lead you can use the _id of the status and the rest of the object will be automatically created. Additional statuses can be created, more on that here.
probability	number	false	The probability of the deal, it should match the percentage associated with the status of the opportunity.
dealSize	number	false	The size of the deal in currency.
resources	Resources	false	Array containing all the _ids of resources associated with the opportunity.
createdAt	date	readonly	The date when the opportunity has been created.
createdBy	id	readonly	The user that created the opportunity.
modifiedAt	date	readonly	The user that did the last modification to the opportunity. If no update is made this field will match the `createdBy` field.
modifiedBy	id	readonly	The user that did the last modification to the opportunity. Before the first modification, this field equals to the `createdBy` field.