Features API

Features belong to releases. This means that if you want to create one then you must scope it to a release.

You can return a result set which is unfiltered, or filter by release , product , or epic. All these means of listing features can be further filtered by specific criteria like name, modification date, tag, or assignee.

Once you have the id of a specific feature, you can inspect, modify, or delete them on the root features resource.

Update a feature

PUT /api/v1/features/:id

Parameters
Name	Description
`id *`	Numeric ID or key of the feature
`name`	Name of the feature
`workflow_kind`	Type of feature
`workflow_status`	Status of the feature — must be a valid status for the selected product.
`release`	Numeric ID or key of the release the feature should be created in.
`description`	Description of the feature — may include HTML formatting.
`created_by`	Email address of the user who created the feature.
`assigned_to_user`	Email address of user that is assigned the feature.
`tags`	Tags to add to the feature. Multiple tags must be separated by commas.
`initial_estimate_text`	The initial estimated effort in time or story points for this feature, depending on the capacity units configured. For time: use min, h, d, w, m. Example: "2d 1h”. 1d = 8h, 1w = 5d, 1m = 22d. For story points: Use p to represent points. Example: "4p”.
`detailed_estimate_text`	The detailed estimated effort in time or story points for this feature, depending on the capacity units configured. For time: use min, h, d, w, m. Example: "2d 1h”. 1d = 8h, 1w = 5d, 1m = 22d. For story points: Use p to represent points. Example: "4p”.
`remaining_estimate_text`	The remaining estimated effort in time or story points for this feature, depending on the capacity units configured. For time: use min, h, d, w, m. Example: "2d 1h”. 1d = 8h, 1w = 5d, 1m = 22d. For story points: Use p to represent points. Example: "4p”.
`initial_estimate`	Set the initial estimated effort in minutes or story points, depending on the capacity units configured.
`detailed_estimate`	Set the detailed estimated effort in minutes or story points, depending on the capacity units configured.
`remaining_estimate`	Set the remaining estimated effort in minutes or story points, depending on the capacity units configured.
`start_date`	Date that work will start on the feature in format YYYY-MM-DD
`due_date`	Date that work is due to be completed on the feature in format YYYY-MM-DD
`release_phase`	Name or id of release phase which the feature belongs to
`initiative`	Name or id of initiative which the feature belongs to
`epic`	Name or id of epic which the feature belongs to
`progress_source`	Source for calculating progress on the feature. Options are: progress_manual, progress_from_requirements, progress_from_remaining_estimate, progress_from_todos.
`progress`	Progress completed on the feature. May only be set when the progress_source is manual.
`team`	Numeric ID or key of the Develop team to assign the feature to.
`team_workflow_status`	Team status of the feature — must be a valid status for the selected team.
`iteration`	ID of sprint to assign the feature to, must belong to the selected team.
`program_increment`	Numeric ID or key of the PI to assign the feature to, must belong to the selected team.

Example request

PUT /api/v1/features/PRJ1-1

Example CURL command

curl "https://company.aha.io/api/v1/features/PRJ1-1" -d '{"feature":{"name":"New name","description":"New description"}}' -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