Opportunities

Operations related to opportunities

Get all Opportunities

get

Returns a list of opportunities with pagination support.

Authorizations

x-api-key

x-api-keystringRequired

Query parameters

pagenumberOptional

Page number to retrieve.

limitnumberOptional

Number of items per page.

namestringOptional

Opportunity name to filter opportunities by (partial match).

contactIdstringOptional

Contact ID to filter opportunities by contact relationship.

Responses

200Success

application/json

401

Unauthorized - missing or invalid API key

get

/api/v1/opportunities

HTTPcURLJavaScriptPython

GET /api/v1/opportunities HTTP/1.1
Host: api.salescaling.com
x-api-key: YOUR_API_KEY
Accept: */*

{
  "statusCode": 200,
  "count": 1,
  "error": "text",
  "data": [
    {
      "id": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
      "name": "Enterprise Software License",
      "amount": 50000,
      "finalAmount": 45000,
      "risk": "Low",
      "priority": "High",
      "description": "Enterprise software license for 500 users",
      "featuredNotes": "Key decision maker is the CTO",
      "nextStep": "FollowUp",
      "closeDate": "2024-03-10T00:00:00.000Z",
      "closeProbability": 75,
      "status": "open",
      "createdAt": "2024-01-15T10:00:00.000Z",
      "updatedAt": "2024-01-15T10:00:00.000Z"
    }
  ]
}

Create Opportunity

post

Creates a new opportunity.

Authorizations

x-api-key

x-api-keystringRequired

Body

application/json

namestringRequired

Name of the opportunity

Example: Enterprise Software License

amountnumberOptional

Opportunity amount

Example: 50000

finalAmountnumberOptional

Final opportunity amount

Example: 45000

riskstring · enumOptional

Opportunity risk level

Example: LowPossible values:

prioritystring · enumOptional

Opportunity priority level

Example: HighPossible values:

descriptionstringOptional

Opportunity description

Example: Enterprise software license for 500 users

featuredNotesstringOptional

Featured notes for the opportunity

Example: Key decision maker is the CTO

nextStepstringOptional

Next step for the opportunity

Example: FollowUp

closeDatestring · date-timeOptional

Actual close date

Example: 2024-03-10T00:00:00.000Z

closeProbabilitynumberOptional

Close probability (0-100)

Example: 75

statusstring · enumOptional

Opportunity status

Example: openPossible values:

Responses

201Success

application/json

401

Unauthorized - missing or invalid API key

post

/api/v1/opportunities

HTTPcURLJavaScriptPython

POST /api/v1/opportunities HTTP/1.1
Host: api.salescaling.com
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 309

{
  "name": "Enterprise Software License",
  "amount": 50000,
  "finalAmount": 45000,
  "risk": "Low",
  "priority": "High",
  "description": "Enterprise software license for 500 users",
  "featuredNotes": "Key decision maker is the CTO",
  "nextStep": "FollowUp",
  "closeDate": "2024-03-10T00:00:00.000Z",
  "closeProbability": 75,
  "status": "open"
}

{
  "statusCode": 200,
  "count": 1,
  "error": "text",
  "data": {
    "id": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
    "name": "Enterprise Software License",
    "amount": 50000,
    "finalAmount": 45000,
    "risk": "Low",
    "priority": "High",
    "description": "Enterprise software license for 500 users",
    "featuredNotes": "Key decision maker is the CTO",
    "nextStep": "FollowUp",
    "closeDate": "2024-03-10T00:00:00.000Z",
    "closeProbability": 75,
    "status": "open",
    "createdAt": "2024-01-15T10:00:00.000Z",
    "updatedAt": "2024-01-15T10:00:00.000Z"
  }
}

Get Opportunity by ID

get

Get an opportunity by ID.

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idstringRequired

Opportunity ID to retrieve.

Responses

200Success

application/json

401

Unauthorized - missing or invalid API key

get

/api/v1/opportunities/{id}

HTTPcURLJavaScriptPython

GET /api/v1/opportunities/{id} HTTP/1.1
Host: api.salescaling.com
x-api-key: YOUR_API_KEY
Accept: */*

{
  "statusCode": 200,
  "count": 1,
  "error": "text",
  "data": {
    "id": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
    "name": "Enterprise Software License",
    "amount": 50000,
    "finalAmount": 45000,
    "risk": "Low",
    "priority": "High",
    "description": "Enterprise software license for 500 users",
    "featuredNotes": "Key decision maker is the CTO",
    "nextStep": "FollowUp",
    "closeDate": "2024-03-10T00:00:00.000Z",
    "closeProbability": 75,
    "status": "open",
    "createdAt": "2024-01-15T10:00:00.000Z",
    "updatedAt": "2024-01-15T10:00:00.000Z"
  }
}

Update Opportunity

put

Updates an existing opportunity.

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idstringRequired

Opportunity ID to update.

Body

application/json

namestringOptional

Name of the opportunity

Example: Enterprise Software License

amountnumberOptional

Opportunity amount

Example: 50000

finalAmountnumberOptional

Final opportunity amount

Example: 45000

riskstring · enumOptional

Opportunity risk level

Example: LowPossible values:

prioritystring · enumOptional

Opportunity priority level

Example: HighPossible values:

descriptionstringOptional

Opportunity description

Example: Enterprise software license for 500 users

featuredNotesstringOptional

Featured notes for the opportunity

Example: Key decision maker is the CTO

nextStepstringOptional

Next step for the opportunity

Example: FollowUp

closeDatestring · date-timeOptional

Actual close date

Example: 2024-03-10T00:00:00.000Z

closeProbabilitynumberOptional

Close probability (0-100)

Example: 75

statusstring · enumOptional

Opportunity status

Example: openPossible values:

Responses

200Success

application/json

401

Unauthorized - missing or invalid API key

put

/api/v1/opportunities/{id}

HTTPcURLJavaScriptPython

PUT /api/v1/opportunities/{id} HTTP/1.1
Host: api.salescaling.com
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 309

{
  "name": "Enterprise Software License",
  "amount": 50000,
  "finalAmount": 45000,
  "risk": "Low",
  "priority": "High",
  "description": "Enterprise software license for 500 users",
  "featuredNotes": "Key decision maker is the CTO",
  "nextStep": "FollowUp",
  "closeDate": "2024-03-10T00:00:00.000Z",
  "closeProbability": 75,
  "status": "open"
}

{
  "statusCode": 200,
  "count": 1,
  "error": "text",
  "data": {
    "id": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
    "name": "Enterprise Software License",
    "amount": 50000,
    "finalAmount": 45000,
    "risk": "Low",
    "priority": "High",
    "description": "Enterprise software license for 500 users",
    "featuredNotes": "Key decision maker is the CTO",
    "nextStep": "FollowUp",
    "closeDate": "2024-03-10T00:00:00.000Z",
    "closeProbability": 75,
    "status": "open",
    "createdAt": "2024-01-15T10:00:00.000Z",
    "updatedAt": "2024-01-15T10:00:00.000Z"
  }
}

Delete Opportunity

delete

Deletes an opportunity by ID.

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idstringRequired

Opportunity ID to delete.

Responses

200Success

application/json

401

Unauthorized - missing or invalid API key

delete

/api/v1/opportunities/{id}

HTTPcURLJavaScriptPython

DELETE /api/v1/opportunities/{id} HTTP/1.1
Host: api.salescaling.com
x-api-key: YOUR_API_KEY
Accept: */*

{
  "statusCode": 200,
  "count": 1,
  "error": "text",
  "data": true
}

Get Opportunity Integrations

get

Returns a list of integrations for a given opportunity ID.

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idstringRequired

Opportunity ID to get integrations from.

Responses

200Success

application/json

401

Unauthorized - missing or invalid API key

get

/api/v1/opportunities/{id}/integrations

HTTPcURLJavaScriptPython

GET /api/v1/opportunities/{id}/integrations HTTP/1.1
Host: api.salescaling.com
x-api-key: YOUR_API_KEY
Accept: */*

{
  "statusCode": 200,
  "count": 1,
  "error": "text",
  "data": {
    "opportunityId": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
    "integrations": [
      {
        "integrationType": "crm",
        "integrationName": "HubSpot",
        "integrationId": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d"
      }
    ]
  }
}

Get Opportunity Contacts

get

Returns a list of contacts associated with an opportunity.

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idstringRequired

Opportunity ID to get contacts from.

Query parameters

pagenumberOptional

Page number to retrieve.

limitnumberOptional

Number of items per page.

Responses

200Success

application/json

401

Unauthorized - missing or invalid API key

get

/api/v1/opportunities/{id}/contacts

HTTPcURLJavaScriptPython

GET /api/v1/opportunities/{id}/contacts HTTP/1.1
Host: api.salescaling.com
x-api-key: YOUR_API_KEY
Accept: */*

{
  "statusCode": 200,
  "count": 1,
  "error": "text",
  "data": [
    {
      "contactId": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
      "contactFirstName": "John",
      "contactLastName": "Doe",
      "contactEmail": "[email protected]",
      "contactTitlePosition": "Software Engineer"
    }
  ]
}

Create Opportunity Contact Relationship

post

Creates a relationship between an opportunity and a contact.

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idstringRequired

Opportunity ID.

Body

application/json

contactIdstringRequired

Contact ID

Example: 5516cd47-2bd0-4f4f-adc2-22524e54ba4d

Responses

201Success

application/json

401

Unauthorized - missing or invalid API key

post

/api/v1/opportunities/{id}/contacts

HTTPcURLJavaScriptPython

POST /api/v1/opportunities/{id}/contacts HTTP/1.1
Host: api.salescaling.com
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "contactId": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d"
}

{
  "statusCode": 200,
  "count": 1,
  "error": "text",
  "data": true
}

Get Opportunity Companies

get

Returns a list of companies associated with an opportunity.

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idstringRequired

Opportunity ID to get companies from.

Query parameters

pagenumberOptional

Page number to retrieve.

limitnumberOptional

Number of items per page.

Responses

200Success

application/json

401

Unauthorized - missing or invalid API key

get

/api/v1/opportunities/{id}/companies

HTTPcURLJavaScriptPython

GET /api/v1/opportunities/{id}/companies HTTP/1.1
Host: api.salescaling.com
x-api-key: YOUR_API_KEY
Accept: */*

{
  "statusCode": 200,
  "count": 1,
  "error": "text",
  "data": [
    {
      "companyId": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d",
      "companyName": "Acme Corp",
      "companyDomain": "acme.com",
      "isPrimary": true
    }
  ]
}

Create Opportunity Company Relationship

post

Creates a relationship between an opportunity and a company.

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idstringRequired

Body

application/json

companyIdstringRequired

Company ID

Example: 5516cd47-2bd0-4f4f-adc2-22524e54ba4d

Responses

201Success

application/json

401

Unauthorized - missing or invalid API key

post

/api/v1/opportunities/{id}/companies

HTTPcURLJavaScriptPython

POST /api/v1/opportunities/{id}/companies HTTP/1.1
Host: api.salescaling.com
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 52

{
  "companyId": "5516cd47-2bd0-4f4f-adc2-22524e54ba4d"
}

{
  "statusCode": 200,
  "count": 1,
  "error": "text",
  "data": true
}

Delete Opportunity Contact Relationship

delete

Deletes a relationship between an opportunity and a contact.

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idstringRequired

Opportunity ID.

contactIdstringRequired

Contact ID.

Responses

200Success

application/json

401

Unauthorized - missing or invalid API key

delete

/api/v1/opportunities/{id}/contacts/{contactId}

HTTPcURLJavaScriptPython

DELETE /api/v1/opportunities/{id}/contacts/{contactId} HTTP/1.1
Host: api.salescaling.com
x-api-key: YOUR_API_KEY
Accept: */*

{
  "statusCode": 200,
  "count": 1,
  "error": "text",
  "data": true
}

Delete Opportunity Company Relationship

delete

Deletes a relationship between an opportunity and a company.

Authorizations

x-api-key

x-api-keystringRequired

Path parameters

idstringRequired

companyIdstringRequired

Company ID.

Responses

200Success

application/json

401

Unauthorized - missing or invalid API key

delete

/api/v1/opportunities/{id}/companies/{companyId}

HTTPcURLJavaScriptPython

DELETE /api/v1/opportunities/{id}/companies/{companyId} HTTP/1.1
Host: api.salescaling.com
x-api-key: YOUR_API_KEY
Accept: */*

{
  "statusCode": 200,
  "count": 1,
  "error": "text",
  "data": true
}