HighLevel: Upload file attachments

← Conversations operations · Get started

Operation gohighlevel.upload_file_attachments

Provider route: POST /conversations/messages/upload. 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["conversations"]["uploadFileAttachments"]>[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.conversations.uploadFileAttachments(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.conversations.upload_file_attachments(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 Upload file attachments — request body — body

Referenced models: Upload file attachments — 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 Upload file attachments — response body

Referenced models: Upload file attachments — response body

Schemas

Upload file attachments — response body

Field	Type	Presence	Description and constraints
$	object	Root
twilioMediaSids	array	Optional	Twilio media SIDs for group SMS (when isGroupSms=true)
twilioMediaSids[]	string	Each item
uploadedFiles	object	Required within parent	Map of uploaded file names to their accessible URLs

Upload file attachments — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
attachmentUrls	array	Required within parent	Array of attachment URLs to upload for the conversation
attachmentUrls[]	string	Each item
chatServiceSid	string	Optional	Twilio chat service SID for group SMS uploads
contactId	string	Required within parent	Contact Id
conversationId	string	Required within parent	Conversation Id
isGroupSms	string	Optional	Flag to indicate group SMS upload flow. When true, only 1 file upload is allowed per request.
locationId	string	Required within parent	Location ID associated with the upload request

Policy, approvals and errors

SDK function policy ID: gohighlevel.upload_file_attachments. Catalog operation: upload-file-attachments. 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: ["conversations/message.write"]

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

Official provider source