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 contact member associated with the opportunity. Either a member or a team is necessary to create a opportunity. |
| team | Company | true | The _id of the contact 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 | string | false | The _id of the status associated with the opportunity. All statuses are part of the leadStatuses collection, which you can find 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. |