Opportunities Overview

The Opportunities API provides full management of sales pipeline records in the HoopAI Platform. Use it to create and update opportunities, move deals through pipeline stages, assign monetary values, query and search opportunities by pipeline or contact, retrieve pipeline definitions and stage configurations, manage followers on opportunity records, and upsert opportunities to avoid duplicates. It is designed for integrating external CRMs, building custom sales dashboards, and automating deal progression logic.

Base URL

https://services.leadconnectorhq.com

Authentication

All endpoints require a Bearer token and an API version header.

Authorization: Bearer <access_token>
Version: 2021-07-28

See OAuth 2.0 to obtain an access token.

OAuth scopes

Scope	Access
`opportunities.readonly`	Read opportunities, pipelines, and lost reasons
`opportunities.write`	Create, update, delete, and upsert opportunities; manage followers

Quick start

Create a new opportunity in a pipeline:

curl -X POST https://services.leadconnectorhq.com/opportunities/ \
  -H "Authorization: Bearer <access_token>" \
  -H "Version: 2021-07-28" \
  -H "Content-Type: application/json" \
  -d '{
    "pipelineId": "pipeline_abc123",
    "locationId": "sadadya1u12basyhasd",
    "name": "Website Redesign Project",
    "pipelineStageId": "stage_xyz456",
    "status": "open",
    "monetaryValue": 5000,
    "contactId": "contact_abc123"
  }'

Endpoints

Method	Path	Description
`POST`	`/opportunities/`	Create opportunity
`GET`	`/opportunities/search`	Search opportunity (GET)
`POST`	`/opportunities/search`	Search opportunities (POST)
`POST`	`/opportunities/upsert`	Upsert opportunity
`GET`	`/opportunities/{id}`	Get opportunity
`PUT`	`/opportunities/{id}`	Update opportunity
`DELETE`	`/opportunities/{id}`	Delete opportunity
`PUT`	`/opportunities/{id}/status`	Update opportunity status
`POST`	`/opportunities/{id}/followers`	Add followers
`DELETE`	`/opportunities/{id}/followers`	Remove followers
`GET`	`/opportunities/pipelines`	Get pipelines
`GET`	`/opportunities/lost-reason`	Get lost reasons

Contacts API — Link opportunities to contact records
Calendars API — Book discovery or follow-up appointments for open deals
Conversations API — Send messages tied to opportunity workflows

Contacts

Opportunities

Businesses

Custom Fields

Objects

Associations

Workflows

Base URL

Authentication

OAuth scopes

Quick start

Endpoints

​Base URL

​Authentication

​OAuth scopes

​Quick start

​Endpoints

​Related

Base URL

Authentication

OAuth scopes

Quick start

Endpoints

Related