SHshiprush
Idea comments

Mark an idea comment as spam

Idea comments can appear in ideas portals. To reply to an idea_comment, specify the parent_idea_comment_id. Its visibility will come from its parent idea comment and cannot be overridden.

put/idea_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

{
  "idea_comment": {
    "spam": "true"
  }
}

Response

Successful operation

Example response

{
  "idea_comment": {
    "id": "622085811",
    "idea_id": "58056975",
    "body": "This is a great idea! We'll get started right away.",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "created_at": "2019-01-01T00:00:00.000Z",
    "visibility": "Visible to idea creator and our employees",
    "parent_idea_comment_id": null,
    "idea_commenter_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"
    },
    "idea": {
      "id": "58056975",
      "name": "Idea 1",
      "reference_num": "PRJ1-I-1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "workflow_status": {
        "id": "3259216",
        "name": "New",
        "position": 1,
        "complete": false,
        "color": "#dce7c6",
        "workflow_status_category": null
      },
      "description": {
        "id": "103757394",
        "body": "Description of idea 1",
        "notable_id": "58056975",
        "notable_type": "Ideas::Idea",
        "editor_version": 1,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "attachments": []
      },
      "url": "https://company.aha.io/ideas/ideas/PRJ1-I-1",
      "resource": "https://company.aha.io/api/v1/ideas/PRJ1-I-1"
    },
    "attachments": []
  }
}

Changes

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