Key results
Update a key result
Changed onput/key_results/{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
idstring required
Id identifier
Request body
Example request
{
"key_result": {
"name": "Another name",
"workflow_status": {
"name": "On track"
},
"watchers": [
689956296
],
"description": "<p>new description</p>",
"current_metric": "30%"
}
}Response
Successful operation
Example response
{
"key_result": {
"id": "631791848",
"name": "KR 1",
"reference_num": "DEMOENT-G-1-KR-1",
"position": 2,
"created_at": "2019-01-01T00:00:00.000Z",
"updated_at": "2019-01-01T00:00:00.000Z",
"progress": null,
"target_metric": "100%",
"starting_metric": "5%",
"current_metric": "20%",
"description": null,
"assigned_to_user": null,
"workflow_status": {
"id": "934242751",
"name": "New",
"position": 1,
"complete": false,
"color": "#dce7c6",
"workflow_status_category": null
},
"custom_fields": [
{
"id": "6776881149496972898",
"key": "stretch_goal",
"name": "Stretch goal",
"updatedAt": "2019-01-01T00:00:00Z",
"type": "string",
"value": "my metric"
}
]
}
}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