HighLevel: Upsert Opportunity

← Opportunities operations · Get started

Operation gohighlevel.upsert_opportunity

Provider route: POST /opportunities/upsert. Alter supplies the connection’s credentials and routing.

Call through Alter

Install @alter-ai/sdk @alter-ai/gohighlevel with npm, or alter-sdk-gohighlevel with pip. Supply your connected customer’s grant ID and the arguments described below.

import { App } from "@alter-ai/sdk";
import { HighLevelIntegration } from "@alter-ai/gohighlevel";

async function execute(input: Parameters<HighLevelIntegration["opportunities"]["upsertOpportunity"]>[0]) {
  const app = new App({ apiKey: process.env.ALTER_API_KEY! });
  try {
    const provider = new HighLevelIntegration(app, { grantId: process.env.PROVIDER_GRANT_ID! });
    const call = await provider.opportunities.upsertOpportunity(input);
    const result = await call.wait();
    return result.bodyJson();
  } finally {
    await app.close();
  }
}

import os
from alter_sdk import App
from alter_sdk_gohighlevel import HighLevelIntegration

async def execute(arguments):
    async with App(api_key=os.environ["ALTER_API_KEY"]) as app:
        provider = HighLevelIntegration(app, {"grant_id": os.environ["PROVIDER_GRANT_ID"]})
        call = await provider.opportunities.upsert_opportunity(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
body	Model	Required within parent	Expand Upsert Opportunity — request body — body

Referenced models: Upsert Opportunity — request body — body

Response

Response media type: application/json. The table describes the pinned successful response. Referenced models link to their complete fields.

Field	Type	Presence	Description and constraints
$	Model	Root	Expand Upsert Opportunity — response body

Referenced models: Upsert Opportunity — response body

Schemas

Upsert Opportunity — response body

Field	Type	Presence	Description and constraints
$	object	Root
new	boolean	Required within parent	Indicates whether the opportunity was newly created (true) or updated (false)
opportunity	object	Required within parent	Updated / New Opportunity

Upsert Opportunity — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
assignedTo	string	Optional	Identifier of the user the opportunity is assigned to
followers	array	Required within parent	contactId
followers[]	string	Each item
followersActionType	string	Required within parent	followers action type One of: add, remove
forecastExpectedCloseDate	string	Optional	Expected close date. Supported formats: YYYY/MM/DD, MM/DD/YYYY, YYYY-MM-DD, MM-DD-YYYY, YYYY.MM.DD, MM.DD.YYYY, or ISO 8601
forecastProbability	number	Optional	Forecast probability
id	string	Optional	opportunityId
isRemoveAllFollowers	boolean	Required within parent	isRemoveAllFollowers
locationId	string	Required within parent	locationId
lostReasonId	string	Optional	lost reason Id
monetaryValue	object	Optional	Monetary value of the opportunity
name	string	Optional	name
pipelineId	string	Required within parent	pipeline Id
pipelineStageId	string	Optional	Identifier of the pipeline stage
status	string	Optional	Current status of the opportunity One of: open, won, lost, abandoned, all

Policy, approvals and errors

SDK function policy ID: gohighlevel.upsert_opportunity. Catalog operation: Upsert-opportunity. Rules can name either ID; function rules distinguish managed calls and conservatively cover raw calls sharing the route. Existing grant permissions and policy rules apply. wait() returns an immediate result or waits for a required approval; it never approves the request itself. Persist the approval ID to resume after a restart.

Provider errors retain their response; JSON decoding raises ProviderAPIError for provider failures. ManagedOperationError identifies contract/input/retention errors. See error handling and provider-specific behavior. Sensitive input may be refused before approval storage. A decoding error never resubmits a write.

Required provider scopes: ["opportunities.write"]

Pinned headers: {"Version": "v3"}

Official provider source