HighLevel: Update message status

← Conversations operations · Get started

Operation gohighlevel.update_message_status

Provider route: PUT /conversations/messages/{messageId}/status. 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"]["updateMessageStatus"]>[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.updateMessageStatus(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_message_status(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.messageId	string	Required within parent
body	Model	Required within parent	Expand Update message status — request body — body

Referenced models: Update message status — 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 Send a new message — response body

Referenced models: Send a new message — response body

Schemas

Send a new message — response body

Field	Type	Presence	Description and constraints
$	object	Root
conversationId	string	Required within parent	Conversation ID.
emailMessageId	string	Optional	This contains the email message ID (only for Email type). Use this ID to send inbound replies through this API to create a threaded email.
forwardData	JSON	Optional	Optional metadata for forwarded email
forwardData (allOf 1)	Model	All variants apply	Expand Send a new message — response body — forward Data email Message Id, forward To Email, forward Whole Thread, message Id, recipient Contact Id, recipient Conversation Id, source Contact Id, source Conversation Id
messageId	string	Required within parent	This is the main Message ID
messageIds	array	Optional	When sending via the GMB channel, we will be returning list of `messageIds` instead of single `messageId`.
messageIds[]	string	Each item
msg	string	Optional	Additional response message when sending a workflow message
status	string	Required within parent	Message status Known values: delivered, failed, pending, read

Referenced models: Send a new message — response body — forward Data email Message Id, forward To Email, forward Whole Thread, message Id, recipient Contact Id, recipient Conversation Id, source Contact Id, source Conversation Id

Update message status — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
emailMessageId	string	Optional	Email message Id
error	JSON	Optional	Error object from the conversation provider
error (allOf 1)	Model	All variants apply	Expand Update message status — request body — body error code, message, type
recipients	array	Optional	Email delivery status for additional email recipients.
recipients[]	string	Each item
status	string	Required within parent	Message status One of: delivered, failed, pending, read

Referenced models: Update message status — request body — body error code, message, type

Send a new message — response body — forward Data email Message Id, forward To Email, forward Whole Thread, message Id, recipient Contact Id, recipient Conversation Id, source Contact Id, source Conversation Id

Field	Type	Presence	Description and constraints
$	object	Root
emailMessageId	string	Optional	Email Message ID of the forwarded email (source)
forwardToEmail	string	Optional	Email address the message was forwarded to (destination)
forwardWholeThread	boolean	Optional	Whether the entire thread was forwarded
messageId	string	Optional	Message ID of the forwarded message (source)
recipientContactId	string	Optional	Contact ID of the recipient of the forwarded email (destination)
recipientConversationId	string	Optional	Conversation ID of the recipient of the forwarded email (destination)
sourceContactId	string	Optional	Contact ID where the forwarded email originated from (source)
sourceConversationId	string	Optional	Conversation ID where the forwarded email originated from (source)

Update message status — request body — body error code, message, type

Field	Type	Presence	Description and constraints
$	object	Root
code	string	Required within parent	Error Code
message	string	Required within parent	Error Message
type	string	Required within parent	Error Type

Policy, approvals and errors

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