create comment
/members/{member}/groups/{group}/comments [POST]
| API Support | Available since | Last updated | Output |
|---|---|---|---|
| 5.1102 | 5.9900 | xml, json |
Description
Create a new group comment from member.
Create a comment for group, reply, url or uri/fragment.
Parameters
| Name | Description | Required | Type | Default |
|---|---|---|---|---|
| content | The content of the comment. XHTML content is sanitized. | yes | string | |
| title | The title of the comment. Max 255 characters | yes | string | |
| assignedto | The ID of the member to assign the task to – status MUST be set | no | long | |
| authoremail | The email address of the author (manager only) | no | the current member’s email | |
| authorname | The name of the author (manager only) | no | string | the current member’s name |
| contenttype | The media type of the comment | no | mediatype | text/plain |
| created | The creation date of the comment, format is ISO-8601 e.g. 2010-10-25T12:26:00+10:00 (manager only) | no | datetime | the current datetime |
| due | The task due date and time in ISO-8601 format – status MUST be set. e.g. 2010-10-25T18:00:00+11:00 | no | datetime | the due date of previous comment in thread |
| labels | A comma-separated list of label values | no | label | |
| notify | The notification behavior | no | notify | normal |
| notify-async | Whether emails are sent asynchronously (for slow email servers) | no | boolean | false |
| priority | The priority for the task e.g. High, Medium, Low – status MUST be set. | no | priority | |
| properties | A pipe-separated list of value pairs (e.g. x=1|y=2|) | no | string | |
| status | The task status value, e.g. Open | no | status | the status of the previous comment in thread |
| type | The type of the comment | no | string | |
| uris | Comma-separated list of attachments as URI ID with optional !fragment | no | long | |
| urls | Comma-separated list of attachments as URL with optional #fragment | no | url | |
| draft | Whether the comment is a draft | no | boolean | false |
Status
The @status attribute must use a value that has been defined in the group properties. For example: “Open”, “Resolved”, “Closed”.
Priority
The @priority attribute must use a value that has been defined in the group properties. For example: “High”, “Medium”, “Low”.
Permission
It depends on the group configuration but the default is that the member on the request needs to be a reviewer or higher.
Response
<comment-creation [notification-email-delayed="true"|
notification-email-failed="true"|
[moderator-email-failed="true"]
[notify-param-ignored="true"]
[public="true"]>
<comment id="123"
contentrole="Comment"
created="2012-03-08T12:34:00+10:00"
[status="Open"]
[due="2012-03-10T18:00:00+10:00"]
[priority="High"]
[moderated="true"]>
<title>Cavern stolen!</title>
<author email="alibaba@fortythieves.com.au"> ... </author>
<assignedto id="123"
date="2012-03-09T..."> ... </assignedto>
<modifiedby id="456"
date="2012-03-09T..."> ... </modifiedby>
<content id="789"
type="text/plain">Sesame opened the door</content>
<attachment>
<uri id="189"> ... </uri>
</attachment>
<attachment fragment="5">
<uri id="289"> ... </uri>
</attachment>
</comment>
</comment-creation>
Error Handling
| Code | Cause / Description |
|---|---|
| 0x0000 | Missing required title |
| 0x1002 | Invalid author email address |
| 0x1301 | Author missing, if the member is invalid |
| 0x1304 | The URL is invalid |
| 0x1307 | The assigned to member is invalid. The status is required to validate |
| 0x1308 | The due date is invalid. The status is required to validate |
| 0x1326 | The content was invalid |
| 0x0201 | Missing required content |
| 0x6301 | If the group has no general discussion |
| 0x6302 | Failed to create new comment |