Ideas
Create an idea
Changed onCreates a new idea with basic details including initial vote count
post/products/{product_id}/ideas
Request
- Base URLhttps://company.aha.io/api/v1
- Auth
- OAuth 2Authorization codehttps://{account-domain}.aha.io/oauth/authorizeToken URLhttps://{account-domain}.aha.io/oauth/token
- or HTTP bearer
- or API key in cookie session
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
product_idstring required
ProductId identifier
Request body
Example request
{
"promotable_type": "feature",
"release_id": 278327321
}Response
Successful operation
Example response
{
"idea": {
"id": "6776881149496389394",
"name": "Comprehensive Feature Request",
"reference_num": "PRJ1-I-251",
"score": 2,
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"product_id": "131414752",
"votes": 15,
"initial_votes": 15,
"status_changed_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": "6776881149484139005",
"body": "<h1>Problem Statement</h1><p>Users need better mobile experience</p><h2>Proposed Solution</h2><p>Native mobile app with offline capabilities</p>",
"notable_id": "6776881149496389394",
"notable_type": "Ideas::Idea",
"editor_version": 2,
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"attachments": []
},
"visibility": "Visible to all ideas portal users",
"admin_response": {
"id": "6776881149490636026",
"body": "Great idea! This aligns with our mobile strategy roadmap. We'll evaluate this for Q3 implementation.",
"notable_id": "6776881149487459138",
"notable_type": "Ideas::IdeaResponse",
"editor_version": 2,
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"attachments": [],
"responded_by_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"
}
},
"url": "https://company.aha.io/ideas/ideas/PRJ1-I-251",
"resource": "https://company.aha.io/api/v1/ideas/PRJ1-I-251",
"product": {
"id": "131414752",
"reference_prefix": "PRJ1",
"name": "Project 1",
"product_line": false,
"created_at": "2019-01-01T00:00:00.000Z",
"url": "https://company.aha.io/projects/PRJ1",
"workspace_type": "product_workspace"
},
"created_by_portal_user": {
"id": "384687358",
"name": "Sammy Smith",
"email": "sammy@smith.com",
"created_at": "2019-01-01T00:00:00.000Z"
},
"created_by_idea_user": {
"id": "244576613",
"name": "Sammy Smith",
"email": "sammy@smith.com",
"created_at": "2019-01-01T00:00:00.000Z",
"title": null
},
"assigned_to_user": null,
"endorsements_count": 0,
"comments_count": 0,
"score_facts": [],
"tags": [
"mobile",
"offline",
"performance",
"UX"
],
"full_tags": [
{
"id": "6776881149483567678",
"name": "performance",
"color": "#e05298"
},
{
"id": "6776881149486951248",
"name": "UX",
"color": "#a952e0"
},
{
"id": "6776881149488941674",
"name": "mobile",
"color": "#bae052"
},
{
"id": "6776881149490298781",
"name": "offline",
"color": "#9ae052"
}
],
"categories": [
{
"id": "552935478",
"name": "Storage",
"parent_id": null,
"project_id": 131414752,
"created_at": "2019-01-01T00:00:00.000Z"
}
],
"themes": [],
"custom_fields": [],
"workflow_status_times": [
{
"status_id": "3259216",
"status_name": "New",
"started_at": "2019-01-01T00:00:00.000Z",
"ended_at": null
}
],
"submitted_idea_portal_record_url": "https://testideaportal1.ideas.aha.io/ideas/PRJ1-I-251",
"integration_fields": []
}
}Changes
- breaking
the response property
//became nullable for the status - breaking
the
//response's property type changed fromobjecttonullfor status - warning
removed the optional property
///from the response with the status - warning
removed the optional property
///from the response with the status
- breaking
- info
added the optional property
//to the response with the status
- info