HighLevel: Update Contacts Tags

← Contacts operations · Get started

Operation gohighlevel.contacts_bulk_update_tags

Provider route: POST /contacts/bulk/tags/update/{type}. 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"]["bulkUpdateTags"]>[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.bulkUpdateTags(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.bulk_update_tags(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.type	string	Required within parent
body	Model	Required within parent	Expand Update Contacts Tags — request body — body

Referenced models: Update Contacts Tags — 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 Update Contacts Tags — response body

Referenced models: Update Contacts Tags — response body

Schemas

Update Contacts Tags — response body

Field	Type	Presence	Description and constraints
$	object	Root
errorCount	JSON	Required within parent
errorCount (anyOf 1)	number	Alternative	Number of errors encountered during the operation
errorCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
responses	array	Required within parent	Responses for each contact processed
responses[]	string	Each item
succeded	boolean	Required within parent	Legacy misspelling of `succeeded`. Deprecated; use `succeeded`.
succeeded	boolean	Required within parent	Indicates if the operation was successful

Update Contacts Tags — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
contacts	array	Required within parent	list of contact ids to be processed
contacts[]	string	Each item
locationId	string	Required within parent	location id from where the bulk request is executed
removeAllTags	boolean	Optional	Option to implement remove all tags. if true, all tags will be removed from the contacts. Can only be used with remove type.
tags	array	Required within parent	list of tags to be added or removed
tags[]	string	Each item

Policy, approvals and errors

SDK function policy ID: gohighlevel.contacts_bulk_update_tags. Catalog operation: contacts.bulk-update-tags. 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