Opportunity

Opportunities represent potential sales orders or business development opportunities for companies. If there are potential sales to be made from prospects, you can create opportunities for them detailing what you expect them to purchase, when they might purchase and how big the purchase is going to be. Opportunity object allows you to perform the following operations:

Retrieve a specific opportunity or a list of opportunities
Create an opportunity
Update an opportunity
Delete an opportunity

cURL
NODE.JS
PHP
C#
PYTHON
JAVA

Name	Description	Format	Attributes
name	Name of the opportunity	string	Filterable, Sortable
prospectId	Identifier of the prospect associated with the opportunity	uuid	Filterable
stageId	Identifier of the opportunity stage	uuid	Filterable
targetDate	A realistic close date by which the opportunity must be won in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
typeId	Identifier of the opportunity type	uuid	Filterable
assignedEntity	Name of the employee to whom the opportunity is assigned	string	Filterable, Sortable
assignedEntityId	Identifier of the employee to whom the opportunity is assigned	uuid	Filterable
assignedGroups []Array: Parent object can have multiple instances of this nested object under it.	List of assigned groups	AssignedGroup Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
campaign	Name of the campaign from which the opportunity originated or which you want to associate with the opportunity	string
campaignId	Identifier of the campaign from which the opportunity originated or which you want to associate with the opportunity	uuid
closedAmount	Amount at which the deal on the opportunity is finalized or closed	double	Filterable, Sortable
closedAmountType	Type of closed amount, whether it is from a proposal, quote, forecast, or any other amount	ClosedAmountType Enumerated type: Click to see possible values and their descriptions.	Filterable, Sortable
closedOn	Date when the opportunity is closed, whether won or lost, in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time	Filterable, Sortable
competition	Name of the competition, i.e., competing business for the opportunity. Competitions can be defined in the competitions list.	string
competitionId	Identifier of the competing business for the opportunity	uuid	Filterable
createdById	Identifier of the user who created this object	uuid	Filterable
createdOn	Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time	Filterable, Sortable
customFields []Array: Parent object can have multiple instances of this nested object under it.	Represents a list of custom fields	CustomFieldData Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
defaultGroup	Name of the default group	string
defaultGroupId	Identifier of the group to which the opportunity belongs	uuid	Filterable
description	A brief description of the opportunity	string
expiresOn	The last expected or actual close date of the opportunity in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time	Filterable, Sortable
forecastAmount	Revenue expected from the opportunity	double	Filterable, Sortable
id	Object identifier	uuid	Filterable
integrationSourceId	Identifier of the integration source for this object. This property is only used by internal BQE apps and does not have any significance for external users	string	Filterable, Sortable
lastUpdated	Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time	Filterable, Sortable
lastUpdatedById	Identifier of the user who last updated this object	uuid	Filterable
lossReason	Reason for losing the opportunity	string	Filterable
nextStep	A quick note about the next stage of the opportunity's sales cycle	string	Filterable
objectState	Represents the state of the object. e.g., new, unchanged, modified or deleted	ObjectState Enumerated type: Click to see possible values and their descriptions.
priority	Priority set for the opportunity. Priorities can be defined in the priorities list, e.g., high, critical, low, etc.	string
priorityId	Identifier of the priority set for the opportunity	uuid	Filterable
probabilityPercent	Current possibility of winning the opportunity. It is a percentage value	double	Filterable, Sortable
projectId	Identifier of the project associated with the opportunity	uuid	Filterable
promotion	Name of the promotion associated with the opportunity	string
promotionId	Identifier of the promotion associated with the opportunity	uuid
prospect	Name of the prospect associated with the opportunity	string	Filterable, Sortable
stage	Current stage of the opportunity. It can be ongoing, won, lost, etc.	string	Filterable, Sortable
status	Current status of the opportunity, e.g., Active or Inactive	Status Enumerated type: Click to see possible values and their descriptions.	Filterable, Sortable
token	Represents the token for update operations	int32
type	Type or category of the opportunity. It can be one of the opportunity types, e.g., new business, migration, etc.	string	Filterable, Sortable
value	Monetary value or worth of the opportunity	double	Filterable, Sortable
version	Implements concurrency on this object	byte

Opportunity List

Use this method to retrieve a list of opportunities. You can optionally pass where, orderBy, and page as query parameters to filter the result. Use the fields parameter to request a subset of the model. By default, a complete model is returned. The expand parameter is used to request nested properties in the model.

Request URL

base_url/crm/opportunity

/crm/opportunity

Method Overview

HTTP Method:

GET

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

Opportunity

Required Scopes:

read:core

Required Subscription:

View Subscription

Request Parameters asterisk denotes required

Name	Parameter Type	Description	Format
fields	Query	Specifies the model properties you want in the response body	string
where	Query	Specifies only those records that match an expression in the query	string
orderBy	Query	Specifies the order of the records	string
page	Query	Specifies the page number and number of records on each page	string
expand	Query	Specifies the nested model properties you want in the response body	string

Response Body

Name	Description	Format
name	Name of the opportunity	string
prospectId	Identifier of the prospect associated with the opportunity	uuid
stageId	Identifier of the opportunity stage	uuid
targetDate	A realistic close date by which the opportunity must be won in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
typeId	Identifier of the opportunity type	uuid
assignedEntity	Name of the employee to whom the opportunity is assigned	string
assignedEntityId	Identifier of the employee to whom the opportunity is assigned	uuid
assignedGroups []Array: Parent object can have multiple instances of this nested object under it.	List of assigned groups	AssignedGroup Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
campaign	Name of the campaign from which the opportunity originated or which you want to associate with the opportunity	string
campaignId	Identifier of the campaign from which the opportunity originated or which you want to associate with the opportunity	uuid
closedAmount	Amount at which the deal on the opportunity is finalized or closed	double
closedAmountType	Type of closed amount, whether it is from a proposal, quote, forecast, or any other amount	ClosedAmountTypeEnumerated type: Click to see possible values and their descriptions.
closedOn	Date when the opportunity is closed, whether won or lost, in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
competition	Name of the competition, i.e., competing business for the opportunity. Competitions can be defined in the competitions list.	string
competitionId	Identifier of the competing business for the opportunity	uuid
createdById	Identifier of the user who created this object	uuid
createdOn	Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
customFields []Array: Parent object can have multiple instances of this nested object under it.	Represents a list of custom fields	CustomFieldData Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
defaultGroup	Name of the default group	string
defaultGroupId	Identifier of the group to which the opportunity belongs	uuid
description	A brief description of the opportunity	string
expiresOn	The last expected or actual close date of the opportunity in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
forecastAmount	Revenue expected from the opportunity	double
id	Object identifier	uuid
integrationSourceId	Identifier of the integration source for this object. This property is only used by internal BQE apps and does not have any significance for external users	string
lastUpdated	Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
lastUpdatedById	Identifier of the user who last updated this object	uuid
lossReason	Reason for losing the opportunity	string
nextStep	A quick note about the next stage of the opportunity's sales cycle	string
objectState	Represents the state of the object. e.g., new, unchanged, modified or deleted	ObjectStateEnumerated type: Click to see possible values and their descriptions.
priority	Priority set for the opportunity. Priorities can be defined in the priorities list, e.g., high, critical, low, etc.	string
priorityId	Identifier of the priority set for the opportunity	uuid
probabilityPercent	Current possibility of winning the opportunity. It is a percentage value	double
projectId	Identifier of the project associated with the opportunity	uuid
promotion	Name of the promotion associated with the opportunity	string
promotionId	Identifier of the promotion associated with the opportunity	uuid
prospect	Name of the prospect associated with the opportunity	string
stage	Current stage of the opportunity. It can be ongoing, won, lost, etc.	string
status	Current status of the opportunity, e.g., Active or Inactive	StatusEnumerated type: Click to see possible values and their descriptions.
token	Represents the token for update operations	int32
type	Type or category of the opportunity. It can be one of the opportunity types, e.g., new business, migration, etc.	string
value	Monetary value or worth of the opportunity	double
version	Implements concurrency on this object	byte

Example Response

[
  {
    "name": "Opportunity",
    "prospectId": "09dc766d-1a2f-4c95-861b-cbe589ec52a4",
    "stageId": "a187d9b4-6829-479f-929d-6dbf78b52194",
    "targetDate": "2024-12-12T05:27:12Z",
    "typeId": "6c52d978-717c-4163-b8a1-8dd5cb4053b6",
    "assignedEntity": "assignedEntity",
    "assignedEntityId": "c8ed9a49-4d47-49ca-9992-744722e5b9d0",
    "assignedGroups": [
      {
        "description": "AssignedGroup Description",
        "id": "b6c8a8f6-a92b-4c67-ad50-d6b0c07d2cbd",
        "name": "AssignedGroup"
      }
    ],
    "campaign": "campaign",
    "campaignId": "cae66df7-b600-40c2-80cd-5dc9866d48a7",
    "closedAmount": 1,
    "closedAmountType": null,
    "closedOn": "2024-12-12T05:27:12Z",
    "competition": "competition",
    "competitionId": "967fcd86-7c3f-470c-8037-5448d7e4b015",
    "createdById": "910de988-ddec-4516-8c36-c6de8a42d3d4",
    "createdOn": "2024-12-12T05:27:12Z",
    "customFields": [
      {
        "definitionId": "39caf736-ad48-47a2-a97f-2cec09728786",
        "createdById": "2d0fdcf6-6e25-4518-ba25-526fc38faac0",
        "createdOn": "2024-12-12T05:27:12Z",
        "description": "CustomFieldData Description",
        "id": "e27037b1-70da-47c4-b0b3-34357cd0e349",
        "integrationSourceId": "integrationSourceId",
        "label": "label",
        "lastUpdated": "2024-12-12T05:27:12Z",
        "lastUpdatedById": "db2a17db-e8c9-45f3-9314-804a524f207a",
        "objectState": null,
        "token": 0,
        "type": null,
        "value": "value",
        "version": "U3dhZ2dlciByb2Nrcw=="
      }
    ],
    "defaultGroup": "defaultGroup",
    "defaultGroupId": "8ca302b9-486f-406e-9033-857e15f8be54",
    "description": "Opportunity Description",
    "expiresOn": "2024-12-12T05:27:12Z",
    "forecastAmount": 1,
    "id": "5ffc22f5-558b-4482-abe2-634e47729d63",
    "integrationSourceId": "integrationSourceId",
    "lastUpdated": "2024-12-12T05:27:12Z",
    "lastUpdatedById": "1441ba0d-ae1f-4aff-9eab-d6ee711165d9",
    "lossReason": "lossReason",
    "nextStep": "nextStep",
    "objectState": null,
    "priority": "priority",
    "priorityId": "748197dc-f673-46ce-a49d-9d0e8c865931",
    "probabilityPercent": 1,
    "projectId": "c8e61392-f048-4ef0-9788-d5f291792476",
    "promotion": "promotion",
    "promotionId": "43c1823f-8f2d-4ef6-9617-3feb5b1d6203",
    "prospect": "prospect",
    "stage": "stage",
    "status": null,
    "token": 0,
    "type": "type",
    "value": 1,
    "version": "U3dhZ2dlciByb2Nrcw=="
  }
]

Retrieve an Opportunity

Use this method to retrieve a specific opportunity. Pass id as the parameter.

Request URL

base_url/crm/opportunity/{id}

/crm/opportunity/{id}

Method Overview

HTTP Method:

GET

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

Opportunity

Required Scopes:

read:core

Required Subscription:

View Subscription

Request Parameters asterisk denotes required

Name	Parameter Type	Description	Format
id	Path	Opportunity identifier	string

Response Body

Name	Description	Format
name	Name of the opportunity	string
prospectId	Identifier of the prospect associated with the opportunity	uuid
stageId	Identifier of the opportunity stage	uuid
targetDate	A realistic close date by which the opportunity must be won in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
typeId	Identifier of the opportunity type	uuid
assignedEntity	Name of the employee to whom the opportunity is assigned	string
assignedEntityId	Identifier of the employee to whom the opportunity is assigned	uuid
assignedGroups []Array: Parent object can have multiple instances of this nested object under it.	List of assigned groups	AssignedGroup Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
campaign	Name of the campaign from which the opportunity originated or which you want to associate with the opportunity	string
campaignId	Identifier of the campaign from which the opportunity originated or which you want to associate with the opportunity	uuid
closedAmount	Amount at which the deal on the opportunity is finalized or closed	double
closedAmountType	Type of closed amount, whether it is from a proposal, quote, forecast, or any other amount	ClosedAmountTypeEnumerated type: Click to see possible values and their descriptions.
closedOn	Date when the opportunity is closed, whether won or lost, in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
competition	Name of the competition, i.e., competing business for the opportunity. Competitions can be defined in the competitions list.	string
competitionId	Identifier of the competing business for the opportunity	uuid
createdById	Identifier of the user who created this object	uuid
createdOn	Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
customFields []Array: Parent object can have multiple instances of this nested object under it.	Represents a list of custom fields	CustomFieldData Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
defaultGroup	Name of the default group	string
defaultGroupId	Identifier of the group to which the opportunity belongs	uuid
description	A brief description of the opportunity	string
expiresOn	The last expected or actual close date of the opportunity in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
forecastAmount	Revenue expected from the opportunity	double
id	Object identifier	uuid
integrationSourceId	Identifier of the integration source for this object. This property is only used by internal BQE apps and does not have any significance for external users	string
lastUpdated	Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
lastUpdatedById	Identifier of the user who last updated this object	uuid
lossReason	Reason for losing the opportunity	string
nextStep	A quick note about the next stage of the opportunity's sales cycle	string
objectState	Represents the state of the object. e.g., new, unchanged, modified or deleted	ObjectStateEnumerated type: Click to see possible values and their descriptions.
priority	Priority set for the opportunity. Priorities can be defined in the priorities list, e.g., high, critical, low, etc.	string
priorityId	Identifier of the priority set for the opportunity	uuid
probabilityPercent	Current possibility of winning the opportunity. It is a percentage value	double
projectId	Identifier of the project associated with the opportunity	uuid
promotion	Name of the promotion associated with the opportunity	string
promotionId	Identifier of the promotion associated with the opportunity	uuid
prospect	Name of the prospect associated with the opportunity	string
stage	Current stage of the opportunity. It can be ongoing, won, lost, etc.	string
status	Current status of the opportunity, e.g., Active or Inactive	StatusEnumerated type: Click to see possible values and their descriptions.
token	Represents the token for update operations	int32
type	Type or category of the opportunity. It can be one of the opportunity types, e.g., new business, migration, etc.	string
value	Monetary value or worth of the opportunity	double
version	Implements concurrency on this object	byte

Example Response

{
  "name": "Opportunity",
  "prospectId": "d0a01d60-e004-4cd9-99ab-bf0df22aabbd",
  "stageId": "ec0d0718-bc67-47b1-a616-8a718cddfb07",
  "targetDate": "2024-12-12T05:27:12Z",
  "typeId": "9791e3bd-e71c-4330-8c1d-0c0643575f32",
  "assignedEntity": "assignedEntity",
  "assignedEntityId": "0759718b-7f09-4993-bc7a-108074547481",
  "assignedGroups": [
    {
      "description": "AssignedGroup Description",
      "id": "311677e2-316f-481f-a730-ec9c18b6e0d1",
      "name": "AssignedGroup"
    }
  ],
  "campaign": "campaign",
  "campaignId": "bedac13a-a385-40de-83f3-a654d7c3b777",
  "closedAmount": 1,
  "closedAmountType": null,
  "closedOn": "2024-12-12T05:27:12Z",
  "competition": "competition",
  "competitionId": "a4385adf-498e-48d4-8c26-d0b7f4b5038e",
  "createdById": "66b3cfe5-6d3b-4795-9953-0c280aab81be",
  "createdOn": "2024-12-12T05:27:12Z",
  "customFields": [
    {
      "definitionId": "e20c37dc-19b0-4bb7-8027-7d638a4a7b5d",
      "createdById": "f333a6a6-3eae-45cf-ba19-10c2bd90e115",
      "createdOn": "2024-12-12T05:27:12Z",
      "description": "CustomFieldData Description",
      "id": "54ac21c1-c168-4218-9076-2d509818c0c2",
      "integrationSourceId": "integrationSourceId",
      "label": "label",
      "lastUpdated": "2024-12-12T05:27:12Z",
      "lastUpdatedById": "3e40713e-d2f8-4405-8794-f89e6b9d3c60",
      "objectState": null,
      "token": 0,
      "type": null,
      "value": "value",
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ],
  "defaultGroup": "defaultGroup",
  "defaultGroupId": "a854285b-028d-46f7-bb16-f97fb59c2a67",
  "description": "Opportunity Description",
  "expiresOn": "2024-12-12T05:27:12Z",
  "forecastAmount": 1,
  "id": "6544284b-bcba-4476-8c16-3687856d62da",
  "integrationSourceId": "integrationSourceId",
  "lastUpdated": "2024-12-12T05:27:12Z",
  "lastUpdatedById": "4c0a5ac2-f712-405c-bee0-25a851a2d88b",
  "lossReason": "lossReason",
  "nextStep": "nextStep",
  "objectState": null,
  "priority": "priority",
  "priorityId": "1ce9a718-a08e-4fbe-8782-9f4145ed65b8",
  "probabilityPercent": 1,
  "projectId": "c9f2ff68-c592-4767-881a-e63395ba2b3b",
  "promotion": "promotion",
  "promotionId": "8021d305-2359-4010-9f7b-f4a68be132f3",
  "prospect": "prospect",
  "stage": "stage",
  "status": null,
  "token": 0,
  "type": "type",
  "value": 1,
  "version": "U3dhZ2dlciByb2Nrcw=="
}

Create an Opportunity

Use this method to save an opportunity. Pass opportunity as the parameter.

Request URL

base_url/crm/opportunity

/crm/opportunity

Method Overview

HTTP Method:

POST

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

Opportunity

Required Scopes:

readwrite:core

Required Subscription:

View Subscription

Request Parameters asterisk denotes required

Name	Parameter Type	Description	Format
body	Body	Opportunity object	Opportunity

Response Body

Name	Description	Format
name	Name of the opportunity	string
prospectId	Identifier of the prospect associated with the opportunity	uuid
stageId	Identifier of the opportunity stage	uuid
targetDate	A realistic close date by which the opportunity must be won in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
typeId	Identifier of the opportunity type	uuid
assignedEntity	Name of the employee to whom the opportunity is assigned	string
assignedEntityId	Identifier of the employee to whom the opportunity is assigned	uuid
assignedGroups []Array: Parent object can have multiple instances of this nested object under it.	List of assigned groups	AssignedGroup Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
campaign	Name of the campaign from which the opportunity originated or which you want to associate with the opportunity	string
campaignId	Identifier of the campaign from which the opportunity originated or which you want to associate with the opportunity	uuid
closedAmount	Amount at which the deal on the opportunity is finalized or closed	double
closedAmountType	Type of closed amount, whether it is from a proposal, quote, forecast, or any other amount	ClosedAmountTypeEnumerated type: Click to see possible values and their descriptions.
closedOn	Date when the opportunity is closed, whether won or lost, in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
competition	Name of the competition, i.e., competing business for the opportunity. Competitions can be defined in the competitions list.	string
competitionId	Identifier of the competing business for the opportunity	uuid
createdById	Identifier of the user who created this object	uuid
createdOn	Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
customFields []Array: Parent object can have multiple instances of this nested object under it.	Represents a list of custom fields	CustomFieldData Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
defaultGroup	Name of the default group	string
defaultGroupId	Identifier of the group to which the opportunity belongs	uuid
description	A brief description of the opportunity	string
expiresOn	The last expected or actual close date of the opportunity in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
forecastAmount	Revenue expected from the opportunity	double
id	Object identifier	uuid
integrationSourceId	Identifier of the integration source for this object. This property is only used by internal BQE apps and does not have any significance for external users	string
lastUpdated	Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
lastUpdatedById	Identifier of the user who last updated this object	uuid
lossReason	Reason for losing the opportunity	string
nextStep	A quick note about the next stage of the opportunity's sales cycle	string
objectState	Represents the state of the object. e.g., new, unchanged, modified or deleted	ObjectStateEnumerated type: Click to see possible values and their descriptions.
priority	Priority set for the opportunity. Priorities can be defined in the priorities list, e.g., high, critical, low, etc.	string
priorityId	Identifier of the priority set for the opportunity	uuid
probabilityPercent	Current possibility of winning the opportunity. It is a percentage value	double
projectId	Identifier of the project associated with the opportunity	uuid
promotion	Name of the promotion associated with the opportunity	string
promotionId	Identifier of the promotion associated with the opportunity	uuid
prospect	Name of the prospect associated with the opportunity	string
stage	Current stage of the opportunity. It can be ongoing, won, lost, etc.	string
status	Current status of the opportunity, e.g., Active or Inactive	StatusEnumerated type: Click to see possible values and their descriptions.
token	Represents the token for update operations	int32
type	Type or category of the opportunity. It can be one of the opportunity types, e.g., new business, migration, etc.	string
value	Monetary value or worth of the opportunity	double
version	Implements concurrency on this object	byte

Example Response

{
  "name": "Opportunity",
  "prospectId": "dcfda850-5abf-4005-b9ba-43aaffcc0aa8",
  "stageId": "d5e2e8c6-0b68-4fc5-8268-8e52829c4328",
  "targetDate": "2024-12-12T05:27:12Z",
  "typeId": "57ad1d4e-cf0a-4b81-83b9-3ec1653c2334",
  "assignedEntity": "assignedEntity",
  "assignedEntityId": "c93e8915-437b-4939-a91d-e416cacd6c42",
  "assignedGroups": [
    {
      "description": "AssignedGroup Description",
      "id": "8dc14740-d9b2-4206-9960-7c0f15e21290",
      "name": "AssignedGroup"
    }
  ],
  "campaign": "campaign",
  "campaignId": "e1aff206-3ff9-435d-8984-a91dd299c5f0",
  "closedAmount": 1,
  "closedAmountType": null,
  "closedOn": "2024-12-12T05:27:12Z",
  "competition": "competition",
  "competitionId": "433fb03b-80ca-412a-ab4c-20df76d965af",
  "createdById": "fc442a16-0aea-4736-a6ff-6924ff367435",
  "createdOn": "2024-12-12T05:27:12Z",
  "customFields": [
    {
      "definitionId": "57d56a6d-4907-45d2-9768-7c566bb53d53",
      "createdById": "5ec79ac8-ba58-4283-b903-b186b6007579",
      "createdOn": "2024-12-12T05:27:12Z",
      "description": "CustomFieldData Description",
      "id": "c7e3ad69-c2fb-4223-a357-ecb7a6d4f5a7",
      "integrationSourceId": "integrationSourceId",
      "label": "label",
      "lastUpdated": "2024-12-12T05:27:12Z",
      "lastUpdatedById": "8a092fce-6db1-4039-8d5c-8939e077b3a7",
      "objectState": null,
      "token": 0,
      "type": null,
      "value": "value",
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ],
  "defaultGroup": "defaultGroup",
  "defaultGroupId": "1efd1ab2-6cae-4f88-bc44-541d4bb5d4a3",
  "description": "Opportunity Description",
  "expiresOn": "2024-12-12T05:27:12Z",
  "forecastAmount": 1,
  "id": "b05af044-50b0-4cf6-b159-8019823dadb7",
  "integrationSourceId": "integrationSourceId",
  "lastUpdated": "2024-12-12T05:27:12Z",
  "lastUpdatedById": "b00ee17c-88fc-4baf-81bf-7768fb7a6f49",
  "lossReason": "lossReason",
  "nextStep": "nextStep",
  "objectState": null,
  "priority": "priority",
  "priorityId": "2d18dc15-d2e8-4d57-9fec-0acd52d3f78d",
  "probabilityPercent": 1,
  "projectId": "75457b36-2a36-4454-85f2-406846e6ee93",
  "promotion": "promotion",
  "promotionId": "4f96f9ed-7e2c-4b0c-8700-d45e08caf27b",
  "prospect": "prospect",
  "stage": "stage",
  "status": null,
  "token": 0,
  "type": "type",
  "value": 1,
  "version": "U3dhZ2dlciByb2Nrcw=="
}

Create an Opportunity List

Use this method to save multiple opportunities. Pass model as the parameter.

Request URL

base_url/crm/opportunity/batch

/crm/opportunity/batch

Method Overview

HTTP Method:

POST

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

Opportunity

Required Scopes:

readwrite:core

Required Subscription:

View Subscription

Request Parameters asterisk denotes required

Name	Parameter Type	Description	Format
body	Body	Opportunity object	OpportunityBatchRequest

Response Body

Name	Description	Format
batchSize	Represents the number of entities in a batch	int64
createdById	Identifier of the user who created this object	uuid
createdOn	Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
id	Object identifier	uuid
integrationSourceId	Identifier of the integration source for this object. This property is only used by internal BQE apps and does not have any significance for external users	string
lastUpdated	Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
lastUpdatedById	Identifier of the user who last updated this object	uuid
objectState	Represents the state of the object. e.g., new, unchanged, modified or deleted	ObjectStateEnumerated type: Click to see possible values and their descriptions.
progress	Represents the total number of entities processed	int64
status	Represents the status of a job e.g., ready, running, completed, or terminated	string
token	Represents the token for update operations	int32
type	Represents the type of a job e.g., create, update, or delete	string
version	Implements concurrency on this object	byte

Example Response

{
  "batchSize": 0,
  "createdById": "b55e23d0-3dcd-4b3b-8588-0e4cd1f6ca59",
  "createdOn": "2024-12-12T05:27:12Z",
  "id": "68f105fe-83f1-40d3-8903-8d1eeec58c75",
  "integrationSourceId": "integrationSourceId",
  "lastUpdated": "2024-12-12T05:27:12Z",
  "lastUpdatedById": "3b3fe2f1-a952-4c43-8da3-fde9a41d5ffc",
  "objectState": null,
  "progress": 0,
  "status": "status",
  "token": 0,
  "type": "type",
  "version": "U3dhZ2dlciByb2Nrcw=="
}

Update an Opportunity

Use this method to update an opportunity. Pass id and opportunity as the parameters.

Request URL

base_url/crm/opportunity/{id}

/crm/opportunity/{id}

Method Overview

HTTP Method:

PUT

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

Opportunity

Required Scopes:

readwrite:core

Required Subscription:

View Subscription

Request Parameters asterisk denotes required

Name	Parameter Type	Description	Format
id	Path	Opportunity identifier	string
body	Body	Opportunity object	Opportunity

Response Body

Name	Description	Format
name	Name of the opportunity	string
prospectId	Identifier of the prospect associated with the opportunity	uuid
stageId	Identifier of the opportunity stage	uuid
targetDate	A realistic close date by which the opportunity must be won in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
typeId	Identifier of the opportunity type	uuid
assignedEntity	Name of the employee to whom the opportunity is assigned	string
assignedEntityId	Identifier of the employee to whom the opportunity is assigned	uuid
assignedGroups []Array: Parent object can have multiple instances of this nested object under it.	List of assigned groups	AssignedGroup Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
campaign	Name of the campaign from which the opportunity originated or which you want to associate with the opportunity	string
campaignId	Identifier of the campaign from which the opportunity originated or which you want to associate with the opportunity	uuid
closedAmount	Amount at which the deal on the opportunity is finalized or closed	double
closedAmountType	Type of closed amount, whether it is from a proposal, quote, forecast, or any other amount	ClosedAmountTypeEnumerated type: Click to see possible values and their descriptions.
closedOn	Date when the opportunity is closed, whether won or lost, in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
competition	Name of the competition, i.e., competing business for the opportunity. Competitions can be defined in the competitions list.	string
competitionId	Identifier of the competing business for the opportunity	uuid
createdById	Identifier of the user who created this object	uuid
createdOn	Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
customFields []Array: Parent object can have multiple instances of this nested object under it.	Represents a list of custom fields	CustomFieldData Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter.
defaultGroup	Name of the default group	string
defaultGroupId	Identifier of the group to which the opportunity belongs	uuid
description	A brief description of the opportunity	string
expiresOn	The last expected or actual close date of the opportunity in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
forecastAmount	Revenue expected from the opportunity	double
id	Object identifier	uuid
integrationSourceId	Identifier of the integration source for this object. This property is only used by internal BQE apps and does not have any significance for external users	string
lastUpdated	Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss	date-time
lastUpdatedById	Identifier of the user who last updated this object	uuid
lossReason	Reason for losing the opportunity	string
nextStep	A quick note about the next stage of the opportunity's sales cycle	string
objectState	Represents the state of the object. e.g., new, unchanged, modified or deleted	ObjectStateEnumerated type: Click to see possible values and their descriptions.
priority	Priority set for the opportunity. Priorities can be defined in the priorities list, e.g., high, critical, low, etc.	string
priorityId	Identifier of the priority set for the opportunity	uuid
probabilityPercent	Current possibility of winning the opportunity. It is a percentage value	double
projectId	Identifier of the project associated with the opportunity	uuid
promotion	Name of the promotion associated with the opportunity	string
promotionId	Identifier of the promotion associated with the opportunity	uuid
prospect	Name of the prospect associated with the opportunity	string
stage	Current stage of the opportunity. It can be ongoing, won, lost, etc.	string
status	Current status of the opportunity, e.g., Active or Inactive	StatusEnumerated type: Click to see possible values and their descriptions.
token	Represents the token for update operations	int32
type	Type or category of the opportunity. It can be one of the opportunity types, e.g., new business, migration, etc.	string
value	Monetary value or worth of the opportunity	double
version	Implements concurrency on this object	byte

Example Response

{
  "name": "Opportunity",
  "prospectId": "9b45915e-5b3b-4b20-8163-9d634193cdfe",
  "stageId": "2f3dad4d-9cbe-4ed1-b9f7-045b3a803a9f",
  "targetDate": "2024-12-12T05:27:12Z",
  "typeId": "e47f38ff-ea7a-4b25-b3f2-8beed414e760",
  "assignedEntity": "assignedEntity",
  "assignedEntityId": "1c8e7619-498c-48ae-a26f-67dbdbd55a9c",
  "assignedGroups": [
    {
      "description": "AssignedGroup Description",
      "id": "f006804f-817d-43f7-81bf-fa34d44609be",
      "name": "AssignedGroup"
    }
  ],
  "campaign": "campaign",
  "campaignId": "1097e5e7-06a8-466e-be67-b6c80c4d7c19",
  "closedAmount": 1,
  "closedAmountType": null,
  "closedOn": "2024-12-12T05:27:12Z",
  "competition": "competition",
  "competitionId": "36ad89ba-7328-44e2-acd3-1e9ffbefc292",
  "createdById": "88574da1-76e3-43dc-95bd-0ac7e162ff89",
  "createdOn": "2024-12-12T05:27:12Z",
  "customFields": [
    {
      "definitionId": "b7793eb7-62ed-44dd-8343-46b212cd81c1",
      "createdById": "13a4bc75-be87-4a34-9478-e27012b8973f",
      "createdOn": "2024-12-12T05:27:12Z",
      "description": "CustomFieldData Description",
      "id": "27d756c1-d1c1-4398-99e6-5ba0569af355",
      "integrationSourceId": "integrationSourceId",
      "label": "label",
      "lastUpdated": "2024-12-12T05:27:12Z",
      "lastUpdatedById": "e41fcefc-607b-4e4b-be34-60431c78383f",
      "objectState": null,
      "token": 0,
      "type": null,
      "value": "value",
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ],
  "defaultGroup": "defaultGroup",
  "defaultGroupId": "c43e4df8-6a17-45cf-bf30-266cb928403e",
  "description": "Opportunity Description",
  "expiresOn": "2024-12-12T05:27:12Z",
  "forecastAmount": 1,
  "id": "104b10cd-c28e-48a6-b365-2a2e46b73382",
  "integrationSourceId": "integrationSourceId",
  "lastUpdated": "2024-12-12T05:27:12Z",
  "lastUpdatedById": "04bc3dee-e719-4423-8d07-1d605fa1a839",
  "lossReason": "lossReason",
  "nextStep": "nextStep",
  "objectState": null,
  "priority": "priority",
  "priorityId": "1ac75c11-a404-401d-bcf8-2936c2c8b1cb",
  "probabilityPercent": 1,
  "projectId": "05c6d27c-7e92-43eb-8f42-6f23546afb3e",
  "promotion": "promotion",
  "promotionId": "6e295de4-35bc-4dee-ba24-031a70c3ea09",
  "prospect": "prospect",
  "stage": "stage",
  "status": null,
  "token": 0,
  "type": "type",
  "value": 1,
  "version": "U3dhZ2dlciByb2Nrcw=="
}

Delete an Opportunity

Use this method to delete a specific opportunity. Pass id as the parameter.

Request URL

base_url/crm/opportunity/{id}

/crm/opportunity/{id}

Method Overview

HTTP Method:

DELETE

Content Type:

application/json

Response Format:

N/A

Requires Authentication?

Yes

Headers:

Access Token

Required Scopes:

readwrite:core

Required Subscription:

View Subscription

Request Parameters asterisk denotes required

Name	Parameter Type	Description	Format
id	Path	Opportunity identifier	string

Patch an Opportunity

Use this method to perform partial modifications to an opportunity. Pass id and patch document as parameters.

Request URL

base_url/crm/opportunity/{id}

/crm/opportunity/{id}

Method Overview

HTTP Method:

PATCH

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

Opportunity

Required Scopes:

readwrite:core

Required Subscription:

View Subscription

Request Parameters asterisk denotes required

Name	Parameter Type	Description	Format
id	Path	Opportunity identifier	string
body	Body	A document containing an array of objects with each object representing a single operation to be performed	OpportunityPatchDocument

Response Body

Name	Description	Format

Opportunity

The Opportunity Object

Request URL

Method Overview

Request Parameters asterisk denotes required

Response Body

Request URL

Method Overview

Request Parameters asterisk denotes required

Response Body

Request URL

Method Overview

Request Parameters asterisk denotes required

Response Body

Request URL

Method Overview

Request Parameters asterisk denotes required

Response Body

Request URL

Method Overview

Request Parameters asterisk denotes required

Response Body

Request URL

Method Overview

Request Parameters asterisk denotes required

Request URL

Method Overview

Request Parameters asterisk denotes required

Response Body