HighLevel: Send a new message

← Conversations operations · Get started

Operation gohighlevel.send_a_new_message

Provider route: POST /conversations/messages. 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"]["sendANewMessage"]>[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.sendANewMessage(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.send_a_new_message(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 Send a new message — request body — body

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

Send a new message — request body — body

Field	Type	Presence	Description and constraints
$	object	Root
appointmentId	string	Optional	ID of the associated appointment
attachments	array	Optional	Array of attachment URLs
attachments[]	string	Each item
contactId	string	Required within parent	ID of the contact receiving the message
conversationProviderId	string	Optional	ID of conversation provider
customSubtypeId	string	Optional	Custom subtype ID for email unsubscription preferences. Only applies to email messages.
emailBcc	array	Optional	Array of BCC email addresses
emailBcc[]	string	Each item
emailCc	array	Optional	Array of CC email addresses
emailCc[]	string	Each item
emailFrom	string	Optional	Email address to send from
emailReplyMode	string	Optional	Mode for email replies One of: reply, reply_all
emailTo	string	Optional	Email address to send to, if different from contact's primary email. This should be a valid email address associated with the contact.
forward	JSON	Optional	Forwarding configuration for emails
forward (allOf 1)	Model	All variants apply	Expand Send a new message — request body — body forward email Message Id, forward Whole Thread, is Forwarded, message Id, recipient Contact Id, recipient Conversation Id, source Contact Id, source Conversation Id, to Email
fromNumber	string	Optional	Phone number used as the sender number for outbound messages
html	string	Optional	HTML content of the message
message	string	Optional	Text content of the message
optimizationPeriod	string	Optional	Optimization period in hours (24h, 48h, or 72h) One of: 24h, 48h, 72h
replyMessageId	string	Optional	ID of message being replied to
scheduledTimestamp	number	Optional	UTC Timestamp (in seconds) at which the message should be scheduled
status	string	Required within parent	Message status One of: delivered, failed, pending, read
subType	object	Required within parent	Type of message being sent
subject	string	Optional	Subject line for email messages
templateId	string	Optional	ID of message template
threadId	string	Optional	ID of message thread. For email messages, this is the message ID that contains multiple email messages in the thread
toNumber	string	Optional	Recipient phone number for outbound messages
type	string	Required within parent	Type of message being sent One of: SMS, RCS, Email, WhatsApp, IG, FB, Custom, Live_Chat, TIKTOK
usesNativeSchedulingAi	boolean	Optional	Whether the scheduled email uses native AI for the email scheduling

Referenced models: Send a new message — request body — body forward email Message Id, forward Whole Thread, is Forwarded, message Id, recipient Contact Id, recipient Conversation Id, source Contact Id, source Conversation Id, to Email

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)

Send a new message — request body — body forward email Message Id, forward Whole Thread, is Forwarded, message Id, recipient Contact Id, recipient Conversation Id, source Contact Id, source Conversation Id, to Email

Field	Type	Presence	Description and constraints
$	object	Root
emailMessageId	string	Optional	Email Message ID of the specific email being forwarded (source) - Required for single email forward, ignored for thread forward
forwardWholeThread	boolean	Optional	Specify if forwarding the whole thread or just a single email
isForwarded	boolean	Required within parent	Specify if this is a forwarded email
messageId	string	Optional	Message ID of the email thread being forwarded (source) - REQUIRED for forwarding
recipientContactId	string	Optional	Contact ID of recipient when forwarding (destination)
recipientConversationId	string	Optional	Conversation ID of recipient when forwarding (destination)
sourceContactId	string	Optional	Contact ID where the forwarded email originated from (source) - Auto-populated if not provided
sourceConversationId	string	Optional	Conversation ID where the forwarded email originated from (source) - Auto-populated if not provided
toEmail	string	Optional	Email address to forward to (destination)

Policy, approvals and errors

SDK function policy ID: gohighlevel.send_a_new_message. Catalog operation: send-a-new-message. 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