HighLevel: Remove Followers — opportunities remove Followers Opportunity

← Opportunities operations · Get started

Operation gohighlevel.remove_followers_opportunity

Provider route: DELETE /opportunities/{id}/followers. 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"]["removeFollowersOpportunity"]>[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.removeFollowersOpportunity(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.remove_followers_opportunity(arguments)
        result = await call.wait()
        return result.body_json()

Input

Field	Type	Presence	Description and constraints
$	object	Root	Additional keys: not allowed
path	object	Required within parent	Additional keys: not allowed
path.id	string	Required within parent
query	object	Optional	Additional keys: not allowed
query.isRemoveAllFollowers	boolean	Optional
body	Model	Required within parent	Expand Add Followers — opportunities add Followers Opportunity — request body — body

Referenced models: Add Followers — opportunities add Followers 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 Remove Followers — opportunities remove Followers Opportunity — response body

Referenced models: Remove Followers — opportunities remove Followers Opportunity — response body

Schemas

Remove Followers — opportunities remove Followers Opportunity — response body

Field	Type	Presence	Description and constraints
$	object	Root
followers	array	Optional	Current list of all follower user IDs after the operation
followers[]	string	Each item
followersRemoved	array	Optional	User IDs that were successfully removed as followers
followersRemoved[]	string	Each item

Add Followers — opportunities add Followers Opportunity — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
followers	array	Required within parent	Array of user IDs to add or remove as followers (max 10)
followers[]	string	Each item

Policy, approvals and errors

SDK function policy ID: gohighlevel.remove_followers_opportunity. Catalog operation: remove-followers-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