SHshiprush
Comments

Create a comment on a release phase

Comments can be added to and listed as a sub-resource on any resource that supports them. These resources support comments:

  • Features
  • Epics
  • Requirements
  • Ideas
  • Initiatives
  • Goals
  • Releases
  • Release phases
  • To-dos

They can be listed product-wide, or retrieved from anywhere in the system using the root comments resource.

To reply to a comment, specify the parent_comment_id when creating a comment. The parent must be a top-level comment on the same resource; replies to replies are not supported.

post/release_phases/{release_phase_id}/comments

Request

Path parameters

release_phase_idstring required

ReleasePhaseId identifier

Request body

Example request

{
  "comment": {
    "body": "<p>Updated comment body.</p>"
  }
}

Response

Successful operation

Example response

{
  "comment": {
    "id": "6776881149489205523",
    "body": "<p>This is the comment body for a to-do.</p>",
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "parent_comment_id": null,
    "user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z"
    },
    "attachments": [],
    "url": "https://company.aha.io/comments/6776881149489205523",
    "resource": "https://company.aha.io/api/v1/comments/6776881149489205523",
    "commentable": {
      "type": "Task",
      "id": "748715293",
      "product_id": "131414752",
      "url": "https://company.aha.io/tasks/748715293",
      "resource": "https://company.aha.io/api/v1/tasks/748715293"
    }
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.