Site:API:Comments
From Metrixstream
Contents |
Comments
Add Comment
This API call is responsible for adding a comment to an object.
Authentication Restrictions
Any authenticated user.
Required Parameters
- action=comment
- verb=addcomment
- objtype
- content, owner, user
- objid
- msg
- the comment message; no more than 2048 characters.
Successful Response
- status=ok
- item
- comment
- id
- the id of the newly created comment.
Edit Comment
This API call is responsible for editing a comment.
Authentication Restrictions
Moderators and Comment authors.
Required Parameters
- action=comment
- verb=editcomment
- commentId
- The id of the comment.
Optional Parameters
- msg
- the comment message; Comment authors have a 15 minute window to edit their comment; Moderators can always edit.
- approved=yes|no
- the comment approval state; Only Moderators have access to this field.
Successful Response
- status=ok
Delete Comment
This API call is responsible for deleting a comment.
Authentication Restrictions
Moderators; Comment owners;
Required Parameters
- action=comment
- verb=delcomment
- commentId
- The id of the comment.
Successful Response
- status=ok