Comment on a post. Adds a Markdown comment to a post, or a reply with reply_to (replies to a reply join its thread). visibility internal keeps it to the team; replies to internal comments must be internal. Team members can @mention colleagues via mentions, and with on_behalf_of post a customer's comment. Pass idempotency_key. A team member's public comment emails the post's customer followers (per their email settings); any comment notifies team members who own, wrote, commented on or follow the post, and mentioned members. Commenting customers follow the post.
Toolset
core
Who can call it
OwnersManagersContributorsCustomersAPI keys
REST
POST /api/v1/w/{workspace}/posts/{post}/comments
Behavior
changes dataaccepts idempotency_key
Input
Field
Type
Description
postrequired
string
The post's ID (pst_…) or slug (the last part of its portal URL).
bodyrequired
string
Markdown. Raw HTML is shown as text, not rendered.
visibility
one of: public, internal
Default public, or the thread's visibility for replies. internal is team only.
reply_to
string
ID with prefix "cmt_"
mentions
array of string
Team members to @mention, by member ID or email. Team only.
on_behalf_of
object
Team and service accounts only: the end user this post is from. Found by user_id, external_id or email, and created if missing.
idempotency_key
string
Retry-safe key. Repeating a call with the same key returns the first result.
Output
Field
Type
Description
idrequired
string
ID with prefix "cmt_"
post_idrequired
string
ID with prefix "pst_"
parent_idrequired
string or null
The comment this replies to; null at the top level.
authorrequired
object
bodyrequired
string or null
Markdown; null once the comment is deleted.
visibilityrequired
one of: public, internal
public: everyone who can see the post. internal: team members only.
mentionsrequired
array of object
deletedrequired
boolean
Shown only to keep a deleted comment's replies in place.