HighLevel: Bulk Delete Trash Files or Folders
HighLevel medias.bulkDeleteMediaObjects: arguments, response, policy and SDK examples.
← Medias operations · Get started
Operation gohighlevel.bulk_delete_media_objects
Provider route: PUT /medias/delete-files. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “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["medias"]["bulkDeleteMediaObjects"]>[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.medias.bulkDeleteMediaObjects(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom 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.medias.bulk_delete_media_objects(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
body | Model | Required within parent | Expand Bulk Delete Trash Files or Folders — request body — body |
Referenced models: Bulk Delete Trash Files or Folders — request body — body
Response
Section titled “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 |
|---|---|---|---|
$ | JSON | Root |
Schemas
Section titled “Schemas”Bulk Delete Trash Files or Folders — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
altId | string | Required within parent | Location identifier |
altType | string | Required within parent | Type of entity that owns the files One of: location |
filesToBeDeleted | array | Required within parent | Array of file objects to be deleted or trashed |
filesToBeDeleted[] | Model | Each item | Expand Bulk Delete Trash Files or Folders — request body — body files To Be Deleted item |
status | string | Required within parent | Status to set for the files (deleted or trashed) One of: deleted, trashed |
Referenced models: Bulk Delete Trash Files or Folders — request body — body files To Be Deleted item
Bulk Delete Trash Files or Folders — request body — body files To Be Deleted item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
_id | string | Required within parent | Unique identifier of the file or folder to be deleted |
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: gohighlevel.bulk_delete_media_objects. Catalog operation: bulk-delete-media-objects. 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"}