How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

HighLevel Messages API

Documentation for Conversations API

HighLevel Messages API is one of 117 APIs that HighLevel publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 60 JSON Schema definitions.

Tagged areas include Message. The published artifact set on APIs.io includes an OpenAPI specification and 60 JSON Schemas.

This API exposes 16 operations across 16 paths, and defines 25 schemas. It is described by OpenAPI 3.2.0, at version 1.0.

Requests are made against a single base URL, https://services.leadconnectorhq.com.

16 operations 16 paths 25 schemas 1 DELETE6 GET7 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.0
Base URL
https://api.gohighlevel.com
Authentication
HTTP Bearer, HTTP Bearer, HTTP Bearer, HTTP Bearer, HTTP Bearer
Resource Areas
1

Authentication & Security 5

HighLevel Messages API declares 5 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer). It accepts HTTP bearer tokens (JWT) (Location-Access). It accepts HTTP bearer tokens (JWT) (Location-Access-Only). It accepts HTTP bearer tokens (JWT) (Agency-Access). It accepts HTTP bearer tokens (JWT) (Agency-Access-Only).

  • bearer — Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.
  • Location-Access — Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.
  • Location-Access-Only — Use the Access Token generated with user type as Sub-Account.
  • Agency-Access — Use the Access Token generated with user type as Agency (OR) Private Integration Token of Agency.
  • Agency-Access-Only — Use the Access Token generated with user type as Agency.

Paths & Operations 16

Across 16 paths, the API surfaces 16 operations — 1 DELETE, 6 GET, 7 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Messages 16

Documentation for Conversations API

GET
/conversations/messages/export
Export messages by location ID
export-messages-by-location 11 params → 200400401
GET
/conversations/messages/{id}
Get message by message id
get-message 1 param → 200400401
GET
/conversations/{conversationId}/messages
Get messages by conversation id
get-messages 5 params → 200400401
POST
/conversations/messages
Send a new message
send-a-new-message 1 param body → 200400401
POST
/conversations/messages/inbound
Add an inbound message
add-an-inbound-message 1 param body → 200400401
POST
/conversations/messages/outbound
Add an external outbound call
add-an-outbound-message 1 param body → 200400401
POST
/conversations/messages/review-reply
Send a review reply to Google My Business
send-review-reply 1 param body → 200400401
DELETE
/conversations/messages/{messageId}/schedule
Cancel a scheduled message
cancel-scheduled-message 2 params → 200400401
POST
/conversations/messages/upload
Upload file attachments
upload-file-attachments 1 param body → 200400401413415
POST
/conversations/messages/upload/initiate
Initiate file upload to GCS
initiate-file-upload 1 param body → 200400401413
POST
/conversations/messages/upload/complete
Complete file upload
complete-file-upload 1 param body → 200400401404
PUT
/conversations/messages/{messageId}/status
Update message status
update-message-status 2 params body → 200400401
PUT
/conversations/messages/{messageId}/attachments
Add message attachments
add-message-attachments 2 params body → 200400401403404
GET
/conversations/messages/{messageId}/locations/{locationId}/recording
Get Recording by Message ID
get-message-recording 3 params → 200400401
GET
/conversations/locations/{locationId}/messages/{messageId}/transcription
Get transcription by Message ID
get-message-transcription 3 params → 200400401
GET
/conversations/locations/{locationId}/messages/{messageId}/transcription/download
Download transcription by Message ID
download-message-transcription 3 params → 200400401

Schemas 25

The contract defines 25 schemas that model the data the API accepts and returns. The most detailed are SendMessageBodyDto (25 properties), ProcessMessageBodyDto (17 properties), GetMessageResponseDto (17 properties), ForwardConfigDto (9 properties). Each schema is shown below with its type and property counts.

SendMessageBodyDto
object
25 properties 4 required
CompleteFileUploadDto
object
5 properties 5 required
UpdateMessageStatusDto
object
4 properties 1 required
ProcessOutboundMessageBodyDto
object
7 properties 3 required
ForwardResponseDto
object
8 properties
InitiateFileUploadResponseDto
object
5 properties 5 required
SendReviewReplyDto
object
3 properties 3 required
GetMessageTranscriptionResponseDto
object
6 properties 6 required
ProcessMessageResponseDto
object
7 properties 4 required
UploadFilesResponseDto
object
2 properties 1 required
ErrorDto
object
3 properties 3 required
CompleteFileUploadResponseDto
object
2 properties 2 required
UploadFilesDto
object
6 properties 4 required
AddMessageAttachmentsDto
object
1 property 1 required
InitiateFileUploadDto
object
6 properties 5 required
SendMessageResponseDto
object
7 properties 3 required
CancelScheduledResponseDto
object
2 properties 2 required
GetMessageResponseDto
object
17 properties 9 required
ProcessMessageBodyDto
object
17 properties 4 required
ForwardConfigDto
object
9 properties 1 required
MessageMeta
object
3 properties
GetMessagesByConversationResponseDto
object
3 properties 3 required
ExportMessagesResponseDto
object
3 properties 2 required
CallDataDTO
object
3 properties
UploadFilesErrorResponseDto
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

highlevel-messages-api-openapi.yml Raw ↑

Other APIs HighLevel publishes across the network.

HighLevel Account API
HighLevel Actions API
HighLevel Affiliates API
HighLevel Agents API
HighLevel App Billing Management API
HighLevel App Management API
HighLevel Appointment Notes API
HighLevel Appointments API
HighLevel Associations API
HighLevel Availability API
HighLevel Blogs API
HighLevel Brand Boards API
Where this information came from

This is an independent, third-party profile of HighLevel Messages API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.