HighLevel: Update Conversation

← Conversations operations · Get started

Operation gohighlevel.update_conversation

Provider route: PUT /conversations/{conversationId}. 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"]["updateConversation"]>[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.updateConversation(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.update_conversation(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.conversationId	string	Required within parent
body	Model	Required within parent	Expand Update Conversation — request body — body

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

Referenced models: Update Conversation — response body

Schemas

Update 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 Update Conversation — response body — conversation assigned To, contact Id, deleted, id, inbox, last Message Body, last Message Date, last Message Type, location Id, starred, unread Count, user Id
success	boolean	Required within parent	Boolean value as the API response.

Referenced models: Update Conversation — response body — conversation assigned To, contact Id, deleted, id, inbox, last Message Body, last Message Date, last Message Type, location Id, starred, unread Count, user Id

Update Conversation — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
feedback	string	Optional	Live chat feedback value for the conversation One of: positive, negative
locationId	string	Required within parent	Location ID as string
starred	boolean	Optional	Starred status of the conversation.
unreadCount	number	Optional	Count of unread messages in the conversation

Update Conversation — response body — conversation assigned To, contact Id, deleted, id, inbox, last Message Body, last Message Date, last Message Type, location Id, starred, unread Count, user Id

Field	Type	Presence	Description and constraints
$	object	Root
assignedTo	string	Optional	Assigned User ID as string
contactId	string	Required within parent	Contact ID as string
deleted	boolean	Required within parent	Deleted status of the conversation.
id	string	Optional	Contact ID as string
inbox	boolean	Optional	Inbox status of the conversation.
lastMessageBody	string	Optional	Last message body as string
lastMessageDate	string	Optional	Last message date as UTC
lastMessageType	string	Optional	Type of the last message sent/received in the conversation. Known values: TYPE_CALL, TYPE_SMS, TYPE_RCS, TYPE_EMAIL, TYPE_SMS_REVIEW_REQUEST, TYPE_WEBCHAT, TYPE_SMS_NO_SHOW_REQUEST, TYPE_CAMPAIGN_SMS, TYPE_CAMPAIGN_CALL, TYPE_CAMPAIGN_EMAIL, TYPE_CAMPAIGN_VOICEMAIL, TYPE_FACEBOOK, TYPE_CAMPAIGN_FACEBOOK, TYPE_CAMPAIGN_MANUAL_CALL, TYPE_CAMPAIGN_MANUAL_SMS, TYPE_GMB, TYPE_CAMPAIGN_GMB, TYPE_REVIEW, TYPE_INSTAGRAM, TYPE_WHATSAPP, TYPE_CUSTOM_SMS, TYPE_CUSTOM_EMAIL, TYPE_CUSTOM_PROVIDER_SMS, TYPE_CUSTOM_PROVIDER_EMAIL, TYPE_IVR_CALL, TYPE_ACTIVITY_CONTACT, TYPE_ACTIVITY_INVOICE, TYPE_ACTIVITY_PAYMENT, TYPE_ACTIVITY_OPPORTUNITY, TYPE_LIVE_CHAT, TYPE_LIVE_CHAT_INFO_MESSAGE, TYPE_ACTIVITY_APPOINTMENT, TYPE_FACEBOOK_COMMENT, TYPE_INSTAGRAM_COMMENT, TYPE_CUSTOM_CALL, TYPE_INTERNAL_COMMENT, TYPE_ACTIVITY_EMPLOYEE_ACTION_LOG, TYPE_TIKTOK, TYPE_TIKTOK_COMMENT, TYPE_ACTIVITY_WHATSAPP, TYPE_FORM_SUBMISSION, TYPE_SMS_REACTION
locationId	string	Required within parent	Location ID as string
starred	boolean	Optional	Starred status of the conversation.
unreadCount	JSON	Optional
unreadCount (anyOf 1)	number	Alternative	Count of unread messages in the conversation
unreadCount (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
userId	string	Optional	User ID as string

Policy, approvals and errors

SDK function policy ID: gohighlevel.update_conversation. Catalog operation: update-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