HighLevel: Add Remove Contacts From Business

← Contacts operations · Get started

Operation gohighlevel.add_remove_contact_from_business

Provider route: POST /contacts/bulk/business. 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["contacts"]["addRemoveContactFromBusiness"]>[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.contacts.addRemoveContactFromBusiness(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.contacts.add_remove_contact_from_business(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 Add Remove Contacts From Business — request body — body

Referenced models: Add Remove Contacts From Business — 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 Add Remove Contacts From Business — response body

Referenced models: Add Remove Contacts From Business — response body

Schemas

Add Remove Contacts From Business — response body

Field	Type	Presence	Description and constraints
$	object	Root
ids	array	Required within parent	List of contact Ids that were updated
ids[]	string	Each item
success	boolean	Required within parent	Whether the bulk update was successful

Add Remove Contacts From Business — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
businessId	JSON	Required within parent
businessId (anyOf 1)	string	Alternative	Business Id to assign to contacts. Pass null to remove business association.
businessId (anyOf 2)	null	Alternative
ids	array	Required within parent	List of contact Ids to update (maximum 50)
ids[]	string	Each item	Maximum length: 50
locationId	string	Required within parent	Location Id

Policy, approvals and errors

SDK function policy ID: gohighlevel.add_remove_contact_from_business. Catalog operation: add-remove-contact-from-business. 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.

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

Official provider source