Returns a comment object for the created comment.
There are two locations where a new comment can be added with the public API:
- A page.
- An existing discussion thread.
The request body will differ slightly depending on which type of comment is being added with this endpoint.
To add a new comment to a page, a
parent object with a
page_id must be provided in the body params.
To add a new comment to an existing discussion thread, a
discussion_id string must be provided in the body params. (Inline comments to start a new discussion thread cannot be created via the public API.)
discussion_id parameter must be provided — not both.
Each Public API endpoint can return several possible error codes. See the Error codes section of the Status codes documentation for more information.
Reminder: Turn on integration comment capabilities
Integration capabilities for reading and inserting comments are off by default.
This endpoint requires an integration to have insert comment capabilities. Attempting to call this endpoint without insert comment capabilities will return an HTTP response with a 403 status code.