Create Comment

POST {{baseUrl}}/api/v2/help_center/:locale/articles/:article_id/comments

Adds a comment to the specified article. Because comments are associated with a specific article translation, or locale, you must specify a locale.

Allowed for

  • End users

Agents with the Help Center manager role can optionally supply a created_at as part of the comment object. If not provided, created_at is set to the current time.

Supplying a notify_subscribers property with a value of false will prevent subscribers to the comment's article from receiving a comment creation email notification. This can be helpful when creating many comments at a time. Specify the property in the root of the JSON object, not in the comment object.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"comment":{"body":"\u003cstring\u003e","locale":"\u003cstring\u003e","author_id":"\u003cinteger\u003e","created_at":"\u003cstring\u003e","html_url":"\u003cstring\u003e","id":"\u003cinteger\u003e","non_author_editor_id":"\u003cinteger\u003e","non_author_updated_at":"\u003cdateTime\u003e","source_id":"\u003cinteger\u003e","source_type":"\u003cstring\u003e","updated_at":"\u003cstring\u003e","url":"\u003cstring\u003e","vote_count":"\u003cinteger\u003e","vote_sum":"\u003cinteger\u003e"}}