Idea votes
Update an idea vote
Changed on"Idea votes" in the web interface are referenced as "idea endorsements" from API endpoints.
put/ideas/{idea_id}/endorsements/{id}
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
idea_idstring required
IdeaId identifier
idstring required
Id identifier
Request body
Example request
{
"idea_endorsement": {
"value": 123.45
}
}Response
Successful operation
Example response
{
"idea_endorsement": {
"id": "53377392",
"idea_id": "58056975",
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"value": null,
"link": null,
"weight": 1,
"endorsed_by_portal_user": {
"id": "646391926",
"name": "John Long",
"email": "john@long.com",
"created_at": "2019-01-01T00:00:00.000Z"
},
"endorsed_by_idea_user": {
"id": "1056507375",
"name": "John Long",
"email": "john@long.com",
"created_at": "2019-01-01T00:00:00.000Z",
"title": null
},
"idea_organization": {
"id": "138732915",
"name": "Acme",
"created_at": "2019-01-01T00:00:00.000Z",
"url": "https://company.aha.io/ideas/idea_organizations/ACCOUNT-O-123",
"resource": "https://company.aha.io/api/v1/idea_organizations/ACCOUNT-O-123"
},
"description": null,
"integration_fields": [
{
"id": "975466318",
"name": "key",
"value": "JRA-123",
"integration_id": 204584239,
"service_name": "jira",
"created_at": "2019-01-01T00:00:00.000Z"
}
],
"custom_fields": [
{
"id": "6776881149489855953",
"key": "vote_priority",
"name": "Priority",
"updatedAt": "2019-01-01T00:00:00Z",
"type": "string",
"value": "P3"
}
],
"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"
}
}
}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