Goals API

Update a goal's watchers

PUT/api/v1/products/:product_id/goals/:id

Parameters
NameDescription
product_id *

Numeric ID or key of the product

id *

Numeric ID of the goal

project_id

Numeric ID or key of the project the goals should be created in

name

Name of the goal

description

Description of the goal and it can include HTML formatting.

effort

Value between 1 and 100 describing the goal's position on the effort axis in the goal chart

value

Value between 1 and 100 describing the goal's position on the value axis in the goal chart

parent_id

ID of a goal to roll up to in the parent line, Roll up a goal to a parent line goal by 1) creating a goal for the parent line 2) choosing that goal in this control. You can then visualize how releases relate to your strategic goals throughout Aha!

success_metric_name

Name of the Metric that will be used to measure this goal's success

success_metric_description

Description of the success metric

success_metric_status

Status of the success metric for the goal

time_frame

Name or ID of time frame for this goal

progress_source

Source for calculating progress on the goal. Options are: progress_manual, progress_from_features, progress_from_releases, progress_from_initiatives, progress_from_descendants, progress_from_features_completed, progress_from_epics.

progress

Progress completed on the goal. May only be set when the progress_source is manual.

Example request

PUT/api/v1/products/PRJ1/goals/602095703

Example CURL command

curl "https://company.aha.io/api/v1/products/PRJ1/goals/602095703" -d '{"goal":{"watchers":[689956296]}}' -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

© 2020 Aha! Labs Inc.All rights reserved