HighLevel: Create a comment or reply
HighLevel socialPlanner.createComment: arguments, response, policy and SDK examples.
← Social planner operations · Get started
Operation gohighlevel.create_comment
Provider route: POST /social-media-posting/comments/{platform}. Alter supplies the connection’s credentials and routing.
Call through Alter
Section titled “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["socialPlanner"]["createComment"]>[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.socialPlanner.createComment(input); const result = await call.wait(); return result.bodyJson(); } finally { await app.close(); }}import osfrom alter_sdk import Appfrom 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.social_planner.create_comment(arguments) result = await call.wait() return result.body_json()| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | Additional keys: not allowed |
path | object | Required within parent | Additional keys: not allowed |
path.platform | string | Required within parent | One of: facebook, instagram, linkedin, community, tiktok, bluesky, youtube, threads |
query | object | Required within parent | Additional keys: not allowed |
query.locationId | string | Required within parent | |
body | Model | Required within parent | Expand Create a comment or reply — request body — body |
Referenced models: Create a comment or reply — request body — body
Response
Section titled “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 a comment or reply — response body |
Referenced models: Create a comment or reply — response body
Schemas
Section titled “Schemas”2 more schemas are linked from the tables above, on the schema pages.
Create a comment or reply — request body — body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
attachments | array | Optional | Attachments for the comment (max 1 image). **Supported on:** Facebook only. **Not supported on:** Instagram, LinkedIn, TikTok, Bluesky, Community — the field is accepted by the API but the attachment will not appear on the comment. (Community processes the field server-side, but external URLs are not rendered due to its bucket restriction.) |
attachments[] | Model | Each item | Expand Create a comment or reply — request body — body attachments item |
content | string | Required within parent | Content of the comment. Per-platform max length: Facebook 8000, Instagram 2200, Linkedin 3000, Community 8000, Tiktok 150, Bluesky 300, Youtube 10000, Threads 500. |
isParentThread | boolean | Required within parent | Set `true` to create a top-level comment on a post (parentId = post ID). Set `false` to create a reply to an existing comment (parentId = comment ID). |
mentions | array | Optional | Mentions for the comment. **Supported on:** Facebook, LinkedIn, Community. **Ignored on:** Instagram, TikTok, Bluesky — the field is accepted but mentions are not rendered on these platforms. |
mentions[] | Model | Each item | Expand Create a comment or reply — request body — body mentions item |
notifyAllGroupMembers | boolean | Optional | When `true`, all members of the Community group receive a push/in-app notification about this comment — equivalent to an `@everyone` broadcast. **Supported on:** Community only. Ignored on all other platforms (the field is accepted but no notification is sent). **Independent of the `mentions` array** — you do not need to add an `@everyone` entry to `mentions` for this to take effect. Conversely, putting the literal text `@everyone` in `content` does **not** by itself trigger notifications; only this flag does. Defaults to `false` (no broadcast notification). Use `true` only when the comment is genuinely intended for every member of the group — overuse may cause members to mute the group. |
parentId | string | Required within parent | For top-level comments (`isParentThread: true`): pass the post ID returned by the posts API. For replies (`isParentThread: false`): pass the parent comment ID returned by the list-comments API. In both cases this must be a valid 24-character Highlevel ID — not the native platform ID. |
Referenced models: Create a comment or reply — request body — body attachments item, Create a comment or reply — request body — body mentions item
Create a comment or reply — response body
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
message | string | Required within parent | Message |
results | JSON | Required within parent | The created comment |
results (allOf 1) | Model | All variants apply | Expand Create a comment or reply — response body — results id, attachments, author, content, created At, is Deleted, is Edited, is Parent Thread, is Post, is Read, level, like Count, origin Id, platform, platform Comment Id, platform Parent Id, platform Post Id, post Id, preview Link, published At, quote Count, reaction Count, reply Count, repost Count, share Count, updated At |
statusCode | JSON | Required within parent | |
statusCode (anyOf 1) | number | Alternative | Status Code |
statusCode (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
success | boolean | Required within parent | Success or Failure |
Create a comment or reply — request body — body attachments item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
type | string | Required within parent | Type of the attachment One of: image |
url | string | Required within parent | URL of the attachment |
Create a comment or reply — request body — body mentions item
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
id | string | Required within parent | Mention ID |
length | number | Required within parent | Mention length |
name | string | Required within parent | Mention name |
offset | number | Required within parent | Mention offset |
slug | string | Optional | Mention slug for community profile link |
Create a comment or reply — response body — results id, attachments, author, content, created At, is Deleted, is Edited, is Parent Thread, is Post, is Read, level, like Count, origin Id, platform, platform Comment Id, platform Parent Id, platform Post Id, post Id, preview Link, published At, quote Count, reaction Count, reply Count, repost Count, share Count, updated At
| Field | Type | Presence | Description and constraints |
|---|---|---|---|
$ | object | Root | |
_id | string | Required within parent | Highlevel comment ID |
attachments | array | Optional | Attachments on the comment |
attachments[] | Model | Each item | Expand Create a comment or reply — response body — results id, attachments, author, content, created At, is Deleted, is Edited, is Parent Thread, is Post, is Read, level, like Count, origin Id, platform, platform Comment Id, platform Parent Id, platform Post Id, post Id, preview Link, published At, quote Count, reaction Count, reply Count, repost Count, share Count, updated At attachments item |
author | JSON | Optional | Author of the comment. May be partial or missing for some sync paths. |
author (allOf 1) | Model | All variants apply | Expand Create a comment or reply — response body — results id, attachments, author, content, created At, is Deleted, is Edited, is Parent Thread, is Post, is Read, level, like Count, origin Id, platform, platform Comment Id, platform Parent Id, platform Post Id, post Id, preview Link, published At, quote Count, reaction Count, reply Count, repost Count, share Count, updated At author id, name, profile Pic |
content | string | Optional | Comment content. May be empty or missing for attachment-only comments. |
createdAt | string | Optional | Time the comment record was created in Highlevel Format: date-time |
isDeleted | boolean | Required within parent | Whether the comment was deleted |
isEdited | boolean | Required within parent | Whether the comment was edited |
isParentThread | boolean | Optional | True if this comment is a top-level comment on the post; false if it is a reply to another comment |
isPost | boolean | Required within parent | True if this record represents the root post (not a comment) |
isRead | boolean | Required within parent | Whether the comment has been read |
level | JSON | Optional | |
level (anyOf 1) | number | Alternative | Comment depth (0 = post, 1 = comment, 2 = reply) |
level (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
likeCount | JSON | Required within parent | |
likeCount (anyOf 1) | number | Alternative | Number of likes on the comment |
likeCount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
originId | string | Required within parent | Connected account / page ID on the native platform |
platform | string | Required within parent | Platform the comment was posted on |
platformCommentId | string | Optional | Native platform comment ID |
platformParentId | string | Optional | Native platform parent ID (the post or comment this is a reply to) |
platformPostId | string | Optional | Native platform post ID |
postId | string | Required within parent | Highlevel post ID |
previewLink | string | Optional | Direct link to view the comment on the native platform |
publishedAt | string | Optional | Time the comment was published on the native platform. May be missing for legacy or webhook-synced records. Format: date-time |
quoteCount | JSON | Required within parent | |
quoteCount (anyOf 1) | number | Alternative | Number of quote posts (platform-specific) |
quoteCount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
reactionCount | JSON | Required within parent | |
reactionCount (anyOf 1) | number | Alternative | Number of reactions on the comment |
reactionCount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
replyCount | JSON | Required within parent | |
replyCount (anyOf 1) | number | Alternative | Number of replies to the comment |
replyCount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
repostCount | JSON | Required within parent | |
repostCount (anyOf 1) | number | Alternative | Number of reposts of the comment (platform-specific) |
repostCount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
shareCount | JSON | Required within parent | |
shareCount (anyOf 1) | number | Alternative | Number of shares of the comment |
shareCount (anyOf 2) | string | Alternative | Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$ |
updatedAt | string | Optional | Time the comment record was last updated in Highlevel Format: date-time |
Referenced models: Create a comment or reply — response body — results id, attachments, author, content, created At, is Deleted, is Edited, is Parent Thread, is Post, is Read, level, like Count, origin Id, platform, platform Comment Id, platform Parent Id, platform Post Id, post Id, preview Link, published At, quote Count, reaction Count, reply Count, repost Count, share Count, updated At attachments item, Create a comment or reply — response body — results id, attachments, author, content, created At, is Deleted, is Edited, is Parent Thread, is Post, is Read, level, like Count, origin Id, platform, platform Comment Id, platform Parent Id, platform Post Id, post Id, preview Link, published At, quote Count, reaction Count, reply Count, repost Count, share Count, updated At author id, name, profile Pic
Policy, approvals and errors
Section titled “Policy, approvals and errors”SDK function policy ID: gohighlevel.create_comment. Catalog operation: create-comment. 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.
Pinned headers: {"Version": "v3"}