SHshiprush
Comments

Update a comment

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.

put/comments/{id}

Request

  • Base URL
    https://company.aha.io/api/v1
  • Auth
    • OAuth 2
      Authorization codehttps://{account-domain}.aha.io/oauth/authorize
      Token URLhttps://{account-domain}.aha.io/oauth/token
    • or HTTP bearer
    • or API key in cookie session
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

Id identifier

Request body

Example request

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

Response

Successful operation

Example response

{
  "comment": {
    "id": "781701978",
    "body": "<p>Updated comment body.</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": [
      {
        "id": "180276963",
        "download_url": "https://company.aha.io/attachments/180276963/token/aaabbbccc9.download?size=original",
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "original_file_size": 123,
        "content_type": "text/plain",
        "file_name": "uploaded_file_name.txt",
        "file_size": 123
      },
      {
        "id": "822785180",
        "download_url": "https://company.aha.io/attachments/822785180/token/aaabbbccc8.download?size=original",
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "original_file_size": 123,
        "content_type": "text/plain",
        "file_name": "uploaded_file_name.txt",
        "file_size": 123
      }
    ],
    "url": "https://company.aha.io/comments/781701978",
    "resource": "https://company.aha.io/api/v1/comments/781701978",
    "commentable": {
      "type": "Feature",
      "id": "1007868956",
      "product_id": "131414752",
      "url": "https://company.aha.io/features/PRJ1-1",
      "resource": "https://company.aha.io/api/v1/features/PRJ1-1"
    }
  }
}

Changes

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