Initiatives API
Update an initiative's custom fields
PUT /api/v1/products/:product_id/initiatives/:id
Name | Description |
---|---|
product_id * | Numeric ID or key of the product |
id * | Numeric ID or key of the initiative |
name | Name of the initiative |
workflow_status | Status of the initiative. |
description | Description of the initiative — may include HTML formatting. |
effort | Effort required for the initiative |
value | Value the initiative brings to the business |
parent_id | ID of an initiative to roll up to in the parent line, Roll up an initiative to a parent line initiative by 1) creating an initiative for the parent line 2) choosing that initiative in this control. You can then visualize how releases relate to your strategic initiatives throughout Aha! |
position | Used to sort initiatives |
presented | Whether this initiative is shown on charts |
start_date | Start date for the initiative in format YYYY-MM-DD |
end_date | End date for the initiative in format YYYY-MM-DD |
time_frame | Name or ID of time frame for this initiative |
progress_source | Source for calculating progress on the initiative. Options are: progress_manual, progress_from_features, progress_from_releases, progress_from_children, progress_from_features_completed, progress_from_epics. |
progress | Progress completed on the initiative. May only be set when the progress_source is manual. |
duration_source | Source for automatically calculating start and end dates. Options are: duration_manual, duration_from_children, duration_from_releases, duration_from_features_epics. |
Example request
PUT /api/v1/products/PRJ1/initiatives/423077122
Example CURL command
curl "https://company.aha.io/api/v1/products/PRJ1/initiatives/423077122" -d '{"initiative":{"custom_fields":[{"key":"initiative_custom_date","value":"2019-01-01"}]}}' -X PUT \
-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
Request
authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
contentType: application/json
accept: application/json
Request body
Response
Status: 200 OK
contentType: application/json; charset=utf-8
Response body