Epics API

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

You can list them all at once, or filter by release or product. All these means of listing epics can be further filtered by specific critera like name, modification date, tag, or assignee.

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

Update an epic's progress source

PUT /api/v1/epics/:id

Parameters
Name	Description
`id *`	Numeric ID or key of the epics
`name`	Name of the epic
`release`	Numeric ID or key of the release the epic should be created in.
`workflow_status`	Status of the epic — must be a valid status for the selected product.
`description`	Description of the epic — may include HTML formatting.
`created_by`	Email address of the user who created the epic.
`assigned_to_user`	Email address of user that is assigned the epic.
`tags`	Tags to add to the epic. Multiple tags must be separated by commas.
`initial_estimate_text`	The initial estimated effort in time or story points for this epic, 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 epic, 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 epic, 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 epic in format YYYY-MM-DD
`due_date`	Date that work is due to be completed on the epic in format YYYY-MM-DD
`initiative`	Name or id of initiative which the epic belongs to
`progress_source`	Source for calculating progress on the epic. Options are: progress_manual, progress_from_features, progress_from_remaining_estimate, progress_from_todos, progress_from_features_completed.
`progress`	Progress completed on the epic. May only be set when the progress_source is manual.
`duration_source`	Source for automatically calculating start and due dates. Options are: duration_manual, duration_from_features.
`team`	Numeric ID or key of the Develop team to assign the epic to.
`team_workflow_status`	Team status of the epic — must be a valid status for the selected team.
`iteration`	ID of sprint to assign the epic to, must belong to the selected team.
`program_increment`	Numeric ID or key of the PI to assign the epic to, must belong to the selected team.

Example request

PUT /api/v1/epics/PRJ1-E-1

Example CURL command

curl "https://company.aha.io/api/v1/epics/PRJ1-E-1" -d '{"epic":{"progress_source":"progress_from_features"}}' -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