api:comments

The following includes the details of how to interface with the comment records through the API.

Record field format

Associated attributes

Nomenclature

• Plural form: "comments"
• Used in the URL pathname
• Singular form: "comment"
• Used for write parameters (Help:API Write Requests)
• Versions: none

Index

Note: group_by as a parameter must be set to comment, or else posts will be returned instead (e.g. group_by=comment).

Search attributes

All of the following are standard attributes with all of their available formats and qualifiers.

• Number syntax
• id
• score
• created_at
• updated_at
• Text syntax
• body
• Boolean syntax
• is_deleted
• is_sticky
• do_not_bump_post
• Post syntax
• post
• User syntax
• creator
• updater

Special search parameters

• body_matches - Case-insensitive wildcard searching on the body text field.
• order - Sets the order of results.
• post_id - Orders by post ID.
• score - Orders by comment score.
• updated_at - Orders by updated_at timestamp.

Show

Create

Create parameters

• Required:
• post_id
• body
• Optional
• do_not_bump_post

Restricted to Moderator+

• Optional
• is_sticky

Update

Update parameters

• Optional:
• body
• is_deleted

Restricted to Moderator+

• Optional
• is_sticky

Delete

Note: This action can also be accomplished using the update comment action by setting is_deleted to true.

Undelete

Note: This action can also be accomplished using the update comment action by setting is_deleted to false.

See also

• Help:Common URL Parameters
• Help:API