Comments

Create Comment Reply

Create a reply to an existing comment thread. The reply author is always the user who authorized the OAuth token. To @mention a user in the reply, include their user ID in double square brackets in the `content` field, as in `[[userId]]`. <Note> The `comment_created` webhook fires automatically when a reply is created. </Note> Required scope | `comments:write`

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

site_idstringRequiredformat: "objectid"
Unique identifier for a Site
comment_thread_idstringRequiredformat: "objectid"
Unique identifier for a Comment Thread

Request

The content of the reply
contentstringRequired<=2040 characters

The text content of the reply. To @mention a user, include their user ID in double square brackets, as in [[userId]].

Response

Reply created successfully
idstring
Unique identifier for the comment thread
commentIdstring
The comment reply unique identifier
siteIdstring
The site unique identifier
pageIdstring
The page unique identifier
breakpointstring
The breakpoint the comment was left on
contentstring
The content of the comment reply
isResolvedbooleanDefaults to false
Boolean determining if the comment thread is resolved
authorobject
lastUpdatedstringRead-onlyformat: "date-string"
The date the item was last updated
createdOnstringRead-onlyformat: "date-string"
The date the item was created
localeIdstringRead-only
The locale unique identifier
mentionedUserslist of objects
List of mentioned users is an empty array until email notifications are sent.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error
429
Too Many Requests Error
500
Internal Server Error