HighLevel: Create Folder

← Medias operations · Get started

Operation gohighlevel.create_media_folder

Provider route: POST /medias/folder. 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["medias"]["createMediaFolder"]>[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.createMediaFolder(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.medias.create_media_folder(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 Create Folder — request body — body

Referenced models: Create Folder — 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 Create Folder — response body

Referenced models: Create Folder — response body

Schemas

Create Folder — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
altId	string	Required within parent	Location Id
altType	string	Required within parent	Type of entity (location only) One of: location
name	string	Required within parent	Name of the folder to be created
parentId	string	Optional	ID of the parent folder (optional)

Create Folder — response body

Field	Type	Presence	Description and constraints
$	object	Root
altId	string	Required within parent	Location identifier that owns this folder
altType	string	Required within parent	Type of entity that owns the folder Known values: location
appFolder	boolean	Optional	Whether this is a system-generated application folder
category	string	Optional	Primary category of content stored in the folder
deleted	boolean	Optional	Whether the folder has been deleted
isEssential	boolean	Optional	Whether the folder is essential and should not be deleted
isPrivate	boolean	Optional	Whether the folder is private and not publicly accessible
lastUpdatedBy	string	Optional	ID of the user who last updated the folder
migrationCompleted	boolean	Optional	Whether the data migration process has been completed for this folder
name	string	Required within parent	Name of the folder
parentId	string	Optional	ID of the parent folder (null for root folders)
pendingUpload	boolean	Optional	Whether there are pending uploads to this folder
relocatedFolder	boolean	Optional	Whether the folder has been moved from its original location
status	string	Optional	Current status of the folder
subCategory	string	Optional	Sub-category of content stored in the folder
type	string	Required within parent	Type of the object (always 'folder' for folders)

Policy, approvals and errors

SDK function policy ID: gohighlevel.create_media_folder. Catalog operation: create-media-folder. 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