Skip to main content

Create Opportunity and Manage Sales Pipeline

Opportunities are a way of managing the piece of business, rather than an individual or company. It is the deal you think you might make and exists to hold the detail of the potential sale. And it's where your team's sales skills will really come into their own.

Create an Opportunity​

The v2 Opportunity AddOpportunity endpoint should be used for opportunity integration. For detailed documentation, visit Opportunity.

Request Payload

{
  "data": {
    "title": "John Doe's Opportunity",
    "accountId": "02e0c9c1-1fef-4757-9a17-9abb92c3169b",
    "pipelineId": "dcf2018a-569b-4f7e-b5b6-c670096a8feb",
    "pipelineStepId": "2401a9a7-8704-4e16-b4fd-a4afcb0277e2",
    "estimatedAmount": 110,
    "estimatedCloseDate": "2022-09-30T14:09:00.000Z",
    "opportunityProducts": [
      {
        "productId": "c9608ca3-3c51-4804-84f6-60953b92608a",
        "quantity": 1
      }
    ],
    "description": "<p>Description</p>",
    "currencyId": "1aa008ba-2ba9-49b2-804b-d7e4b4d2d09a"
  },
  "customFields": {
    "customFieldString1": "Development Team"
  }
}

or

{
  "data": {
    "title": "John Doe's Opportunity",
    "contactId": "02e0c9c1-1fef-4757-9a17-9abb92c3169b",
    "pipelineId": "dcf2018a-569b-4f7e-b5b6-c670096a8feb",
    "pipelineStepId": "2401a9a7-8704-4e16-b4fd-a4afcb0277e2",
    "estimatedAmount": 110,
    "estimatedCloseDate": "2022-09-30T14:09:00.000Z",
    "opportunityProducts": [
      {
        "productId": "c9608ca3-3c51-4804-84f6-60953b92608a",
        "quantity": 1
      }
    ],
    "description": "<p>Description</p>",
    "currencyId": "1aa008ba-2ba9-49b2-804b-d7e4b4d2d09a"
  },
  "customFields": {
    "customFieldString1": "Development Team"
  }
}

Must be associated with Opportunity Contact or Account. In the payloads above, two different examples are given for account and contact.

Response

{
  "success": true,
  "items": "1e54284f-fbfe-48b3-bd9f-a9fd1b547d51"
}

Change Pipeline Step​

To be added...

Won​

It is used when the opportunity and customer requests match and the customer makes a successful purchase.

The v2 Opportunity OpportunityStatusUpdate endpoint should be used for account integration. For detailed documentation, visit Opportunity.

Request Payload

{
  "status": "Won",
  "finalAmount": 100,
  "closedDate": "2022-09-15T14:15:58.950Z"
}

Response

{
  "success": true,
  "items": "1e54284f-fbfe-48b3-bd9f-a9fd1b547d51"
}

Lost​

The v2 Opportunity OpportunityStatusUpdate endpoint should be used for account integration. For detailed documentation, visit Opportunity.


{
  "status": "Won",
  "finalAmount": 100,
  "closedDate": "2022-09-15T14:15:58.950Z",
  "closeReasonId": "39015ecc-c8e7-43d0-acba-8191988485ee",
  "closeDescription": "Insufficiency"
}

Response

{
  "success": true,
  "items": "1e54284f-fbfe-48b3-bd9f-a9fd1b547d51"
}