Idea Comments API
Parameters
| Name | Description |
|---|---|
| idea_id * | Numeric ID or key of the idea the comment should be created for |
Example Request
POST /api/v1/ideas/PRJ1-I-1/idea_comments
Example CURL command
curl "https://company.aha.io/api/v1/ideas/PRJ1-I-1/idea_comments" -d $'{"idea_comment":{"body":"\u003cp\u003eThis is the comment body.\u003c/p\u003e","portal_user":{"email":"new_email@address.com"}}}' -X POST \
-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
Request
Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab Content-Type: application/json Accept: application/json
{
"idea_comment": {
"body": "<p>This is the comment body.</p>",
"portal_user": {
"email": "new_email@address.com"
}
}
}
Response
Status: 200 OK Content-Type: application/json; charset=utf-8
{
"idea_comment": {
"id": "6825596162680721578",
"idea_id": "58056975",
"body": "<p>This is the comment body.</p>",
"created_at": "2019-01-01T00:00:00.000Z",
"idea_commenter_portal_user": {
"id": "6825596162664940814",
"name": "new_email@address.com",
"email": "new_email@address.com",
"created_at": "2019-01-01T00:00:00.000Z"
},
"idea": {
"id": "58056975",
"reference_num": "PRJ1-I-1",
"name": "Idea 1",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "103757394",
"body": "Description of idea 1",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-1",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1"
},
"attachments": [
]
}
}
Parameters
| Name | Description |
|---|---|
| idea_id * | Numeric ID or key of the idea the expected comment |
Example Request
GET /api/v1/ideas/58056975/idea_comments
Example CURL command
curl -g "https://company.aha.io/api/v1/ideas/58056975/idea_comments" -X GET \ -H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \ -H "Content-Type: application/json" \ -H "Accept: application/json"
Request
Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab Content-Type: application/json Accept: application/json
Response
Status: 200 OK Content-Type: application/json; charset=utf-8
{
"idea_comments": [
{
"id": "622085811",
"idea_id": "58056975",
"body": "This is a great idea! We'll get started right away.",
"created_at": "2019-01-01T00:00:00.000Z",
"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",
"reference_num": "PRJ1-I-1",
"name": "Idea 1",
"created_at": "2019-01-01T00:00:00.000Z",
"workflow_status": {
"id": "3259216",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6"
},
"description": {
"id": "103757394",
"body": "Description of idea 1",
"created_at": "2019-01-01T00:00:00.000Z",
"attachments": [
]
},
"url": "http://company.aha.io/ideas/ideas/PRJ1-I-1",
"resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1"
},
"attachments": [
]
}
],
"pagination": {
"total_records": 1,
"total_pages": 1,
"current_page": 1
}
}