HighLevel: Create Conversation

← Conversations operations · Get started

Operation gohighlevel.create_conversation

Provider route: POST /conversations/. 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"]["createConversation"]>[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.createConversation(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.create_conversation(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 Conversation — request body — body

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

Referenced models: Create Conversation — response body

Schemas

Create Conversation — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
contactId	string	Required within parent	Contact ID as string
locationId	string	Required within parent	Location ID as string

Create Conversation — response body

Field	Type	Presence	Description and constraints
$	object	Root
conversation	JSON	Required within parent	Conversation data of the provided conversation ID.
conversation (allOf 1)	Model	All variants apply	Expand Create Conversation — response body — conversation assigned To, contact Id, date Added, date Updated, deleted, id, last Message Date, location Id
success	boolean	Required within parent	Indicates whether the API request was successful.

Referenced models: Create Conversation — response body — conversation assigned To, contact Id, date Added, date Updated, deleted, id, last Message Date, location Id

Create Conversation — response body — conversation assigned To, contact Id, date Added, date Updated, deleted, id, last Message Date, location Id

Field	Type	Presence	Description and constraints
$	object	Root
assignedTo	string	Optional	Unique identifier of the team member assigned to this conversation
contactId	string	Required within parent	Unique identifier of the contact associated with this conversation
dateAdded	string	Required within parent	Date when the conversation was created
dateUpdated	string	Required within parent	Date when the conversation was last updated
deleted	boolean	Required within parent	Flag indicating if this conversation has been deleted
id	string	Required within parent	Unique identifier for the conversation
lastMessageDate	string	Required within parent	Date of the last message in the conversation
locationId	string	Required within parent	Unique identifier of the business location where this conversation takes place

Policy, approvals and errors

SDK function policy ID: gohighlevel.create_conversation. Catalog operation: create-conversation. 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.write"]

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

Official provider source