HighLevel: Remove Action from Agent

← Conversation AI operations · Get started

Operation gohighlevel.conversation_ai_delete_action

Provider route: DELETE /conversation-ai/agents/{agentId}/actions/{actionId}. 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["conversationAi"]["deleteAction"]>[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.conversationAi.deleteAction(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.conversation_ai.delete_action(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.actionId	string	Required within parent
path.agentId	string	Required within parent

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 Action from Agent — response body

Referenced models: Remove Action from Agent — response body

Schemas

Remove Action from Agent — response body

Field	Type	Presence	Description and constraints
$	object	Root
data	JSON	Required within parent	Deleted action information
data (allOf 1)	Model	All variants apply	Expand Remove Action from Agent — response body — data id
success	boolean	Required within parent	Success status of the request

Referenced models: Remove Action from Agent — response body — data id

Remove Action from Agent — response body — data id

Field	Type	Presence	Description and constraints
$	object	Root
id	string	Required within parent	ID of the deleted action

Policy, approvals and errors

SDK function policy ID: gohighlevel.conversation_ai_delete_action. Catalog operation: conversation-ai.delete-action. 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: ["conversation-ai.write"]

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

Official provider source