API Resources

Full documentation on Aha!'s many resources and sub-resources can be browsed here. The navigation on the side allows you to drill down on a particular point of interest.

Account Backups API


Account Backups let you create a complete off-site backup of your Aha! account. They can be created, listed, and downloaded.

An account backup may only be created once every 24 hours.

The backup file contains a representation of all of the data in the Aha! account, including all relationships. It does not contain user authentication data or integration secrets. The backup does not include any uploaded files.

Account backups are an Enterprise+ exclusive feature.

GET /api/v1/account_backups

List account backups

GET /api/v1/account_backups

Example CURL command

curl -g "https://company.aha.io/api/v1/account_backups" -X GET \
	-H "Authorization: Bearer 584b6d6b83405011f8c6903d2379f4afdf824cef867db391b7bcb5995f603a76" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 584b6d6b83405011f8c6903d2379f4afdf824cef867db391b7bcb5995f603a76
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "account_backups": [

  ]
}

POST /api/v1/account_backups

Trigger creation of an account backup

The backup may take some time to generate (as long as ten minutes in a large account). You should poll the GET endpoint to see when the backup is complete. You should not poll more frequently than once every twenty seconds. Returns an HTTP status of 429 if a backup was already created within the last 24 hours.

POST /api/v1/account_backups

Example CURL command

curl "https://company.aha.io/api/v1/account_backups" -d $'' -X POST \
	-H "Authorization: Bearer 584b6d6b83405011f8c6903d2379f4afdf824cef867db391b7bcb5995f603a76" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 584b6d6b83405011f8c6903d2379f4afdf824cef867db391b7bcb5995f603a76
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "account_backup": {
    "id": "6825595971143404293",
    "status_code": 0,
    "status_description": "In Queue",
    "created_at": "2019-01-01T00:00:00.000Z"
  }
}

GET /api/v1/account_backups/:id

Show account backup

The status field indicates whether the backup is ready the possible values are: 0=queued, 1=working, 2=completed, 3=error.

Parameters

Name Description
id * Numeric ID of the backup to fetch

GET /api/v1/account_backups/6825595971570986515

Example CURL command

curl -g "https://company.aha.io/api/v1/account_backups/6825595971570986515" -X GET \
	-H "Authorization: Bearer 584b6d6b83405011f8c6903d2379f4afdf824cef867db391b7bcb5995f603a76" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 584b6d6b83405011f8c6903d2379f4afdf824cef867db391b7bcb5995f603a76
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "account_backup": {
    "id": "6825595971570986515",
    "status_code": 3,
    "status_description": "Error",
    "created_at": "2019-01-01T00:00:00.000Z"
  }
}

GET /api/v1/account_backups/:id.tgz

Download account backup

Parameters

Name Description
id * Numeric ID of the backup to download

GET /api/v1/account_backups/6825595972114866594.tgz

Example CURL command

curl -g "https://company.aha.io/api/v1/account_backups/6825595972114866594.tgz" -X GET \
	-H "Authorization: Bearer 584b6d6b83405011f8c6903d2379f4afdf824cef867db391b7bcb5995f603a76" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 584b6d6b83405011f8c6903d2379f4afdf824cef867db391b7bcb5995f603a76
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/gzip

Attachments API


Files can be uploaded to Aha! as a sub-resource on any resource that supports them. These resources support attachments:

Notes appear all across the system on various records like Feature descriptions or Release themes. The id for these note fields can be found in the attributes of the record.

The format of an attachment is either a multipart/form-data upload with the input name attachment[data] -- or a json payload pointing to a file url link:

{
  "attachment": {
    "file_url": "http://www.aha.io/",
    "content_type": "text/html",
    "file_name": "home_page.html"
  }
}

POST /api/v1/comments/:comment_id/attachments

Upload a file to a comment

Parameters

Name Description
comment_id * Numeric ID of the comment the uploaded file should be attached to

POST /api/v1/comments/933135074/attachments

Example CURL command

curl "https://company.aha.io/api/v1/comments/933135074/attachments" -d $'------------XnJLe9ZIbbGUYtzPQJ16u1\r
Content-Disposition: form-data; name="attachment[data]"; filename="sample_plain_text.txt"\r
Content-Type: text/plain\r
Content-Length: 27\r
\r
[uploaded data]\r
------------XnJLe9ZIbbGUYtzPQJ16u1--
' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1
Accept: application/json
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="attachment[data]"; filename="sample_plain_text.txt"
Content-Type: text/plain
Content-Length: 27

[uploaded data]
------------XnJLe9ZIbbGUYtzPQJ16u1--

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "attachment": {
    "id": "6825595973047679702",
    "download_url": "http://company.lvh.me/attachments/6825595973047679702/token/7be1784a49a3cb4d8f4612f2043bcfea298ee2e5410a70e504b0d3f53b99e93d.download?size=original",
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "content_type": "text/plain",
    "file_name": "sample_plain_text.txt",
    "file_size": 27
  }
}

POST /api/v1/comments/:comment_id/attachments

Upload a link to a comment

Parameters

Name Description
comment_id * Numeric ID of the comment the uploaded file should be attached to

POST /api/v1/comments/933135074/attachments

Example CURL command

curl "https://company.aha.io/api/v1/comments/933135074/attachments" -d $'attachment[file_url]=http%3A%2F%2Fwww.aha.io%2F&attachment[content_type]=text%2Fhtml&attachment[file_name]=home_page.html' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: multipart/form-data" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: multipart/form-data
Accept: application/json
attachment[file_url]=http%3A%2F%2Fwww.aha.io%2F&attachment[content_type]=text%2Fhtml&attachment[file_name]=home_page.html

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "attachment": {
    "id": "6825595977164456090",
    "download_url": "http://company.lvh.me/attachments/6825595977164456090/token/167dc5dba6a5b95dcf15f04c99e5ee5c1a0ca3b2d3fd88defa62b566692d0562.download?size=original",
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "content_type": "text/html",
    "file_name": "home_page.html",
    "file_size": 0
  }
}

POST /api/v1/idea_comments/:idea_comment_id/attachments

Upload a file to an idea comment

Parameters

Name Description
idea_comment_id * Numeric ID of the idea comment the uploaded file should be attached to

POST /api/v1/idea_comments/622085811/attachments

Example CURL command

curl "https://company.aha.io/api/v1/idea_comments/622085811/attachments" -d $'------------XnJLe9ZIbbGUYtzPQJ16u1\r
Content-Disposition: form-data; name="attachment[data]"; filename="sample_plain_text.txt"\r
Content-Type: text/plain\r
Content-Length: 27\r
\r
[uploaded data]\r
------------XnJLe9ZIbbGUYtzPQJ16u1--
' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1
Accept: application/json
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="attachment[data]"; filename="sample_plain_text.txt"
Content-Type: text/plain
Content-Length: 27

[uploaded data]
------------XnJLe9ZIbbGUYtzPQJ16u1--

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "attachment": {
    "id": "6825595977959696543",
    "download_url": "http://company.lvh.me/attachments/6825595977959696543/token/8662d41bbc96188a8345a0536bdabcd96606a55dd4f07545ea8ef0e127621c4d.download?size=original",
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "content_type": "text/plain",
    "file_name": "sample_plain_text.txt",
    "file_size": 27
  }
}

POST /api/v1/idea_comments/:idea_comment_id/attachments

Upload a link to an idea comment

Parameters

Name Description
idea_comment_id * Numeric ID of the idea comment the uploaded file should be attached to

POST /api/v1/idea_comments/622085811/attachments

Example CURL command

curl "https://company.aha.io/api/v1/idea_comments/622085811/attachments" -d $'attachment[file_url]=http%3A%2F%2Fwww.aha.io%2F&attachment[content_type]=text%2Fhtml&attachment[file_name]=home_page.html' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: multipart/form-data" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: multipart/form-data
Accept: application/json
attachment[file_url]=http%3A%2F%2Fwww.aha.io%2F&attachment[content_type]=text%2Fhtml&attachment[file_name]=home_page.html

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "attachment": {
    "id": "6825595978936141543",
    "download_url": "http://company.lvh.me/attachments/6825595978936141543/token/4bcaa1db5baa713e65475238ff5bc292c0fb7bba5f4a7048ad2c604ff32d3a17.download?size=original",
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "content_type": "text/html",
    "file_name": "home_page.html",
    "file_size": 0
  }
}

POST /api/v1/tasks/:task_id/attachments

Upload a file to a task

Parameters

Name Description
task_id * Numeric ID of the task the uploaded file should be attached to

POST /api/v1/tasks/1041191038/attachments

Example CURL command

curl "https://company.aha.io/api/v1/tasks/1041191038/attachments" -d $'------------XnJLe9ZIbbGUYtzPQJ16u1\r
Content-Disposition: form-data; name="attachment[data]"; filename="sample_plain_text.txt"\r
Content-Type: text/plain\r
Content-Length: 27\r
\r
[uploaded data]\r
------------XnJLe9ZIbbGUYtzPQJ16u1--
' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1
Accept: application/json
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="attachment[data]"; filename="sample_plain_text.txt"
Content-Type: text/plain
Content-Length: 27

[uploaded data]
------------XnJLe9ZIbbGUYtzPQJ16u1--

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "attachment": {
    "id": "6825595979527859309",
    "download_url": "http://company.lvh.me/attachments/6825595979527859309/token/25e131d1bc90741d83f2d2ef79aece527a769e1c4e5fd947f662ae5988b9c5a3.download?size=original",
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "content_type": "text/plain",
    "file_name": "sample_plain_text.txt",
    "file_size": 27
  }
}

POST /api/v1/tasks/:task_id/attachments

Upload a link to a task

Parameters

Name Description
task_id * Numeric ID of the task the uploaded file should be attached to

POST /api/v1/tasks/1041191038/attachments

Example CURL command

curl "https://company.aha.io/api/v1/tasks/1041191038/attachments" -d $'attachment[file_url]=http%3A%2F%2Fwww.aha.io%2F&attachment[content_type]=text%2Fhtml&attachment[file_name]=home_page.html' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: multipart/form-data" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: multipart/form-data
Accept: application/json
attachment[file_url]=http%3A%2F%2Fwww.aha.io%2F&attachment[content_type]=text%2Fhtml&attachment[file_name]=home_page.html

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "attachment": {
    "id": "6825595980242307702",
    "download_url": "http://company.lvh.me/attachments/6825595980242307702/token/6d99a7be495b7d5b9e56d7f6e1b244993429ffa99eab227928b9a8ceb33e0bb5.download?size=original",
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "content_type": "text/html",
    "file_name": "home_page.html",
    "file_size": 0
  }
}

POST /api/v1/custom_fields/:custom_field_id/attachments

Upload a file to a custom note field

Parameters

Name Description
custom_field_id * Numeric ID of the custom field the uploaded file should be attached to

POST /api/v1/custom_fields/432637490/attachments

Example CURL command

curl "https://company.aha.io/api/v1/custom_fields/432637490/attachments" -d $'------------XnJLe9ZIbbGUYtzPQJ16u1\r
Content-Disposition: form-data; name="attachment[data]"; filename="sample_plain_text.txt"\r
Content-Type: text/plain\r
Content-Length: 27\r
\r
[uploaded data]\r
------------XnJLe9ZIbbGUYtzPQJ16u1--
' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1
Accept: application/json
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="attachment[data]"; filename="sample_plain_text.txt"
Content-Type: text/plain
Content-Length: 27

[uploaded data]
------------XnJLe9ZIbbGUYtzPQJ16u1--

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "attachment": {
    "id": "6825595981129001407",
    "download_url": "http://company.lvh.me/attachments/6825595981129001407/token/1ac0b09166030a2e4d45c506883f3fdcf883d856a84dd810fe29284f5d348f4c.download?size=original",
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "content_type": "text/plain",
    "file_name": "sample_plain_text.txt",
    "file_size": 27
  }
}

POST /api/v1/custom_fields/:custom_field_id/attachments

Upload a link to a custom note field

Parameters

Name Description
custom_field_id * Numeric ID of the custom field the uploaded file should be attached to

POST /api/v1/custom_fields/432637490/attachments

Example CURL command

curl "https://company.aha.io/api/v1/custom_fields/432637490/attachments" -d $'attachment[file_url]=http%3A%2F%2Fwww.aha.io%2F&attachment[content_type]=text%2Fhtml&attachment[file_name]=home_page.html' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: multipart/form-data" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: multipart/form-data
Accept: application/json
attachment[file_url]=http%3A%2F%2Fwww.aha.io%2F&attachment[content_type]=text%2Fhtml&attachment[file_name]=home_page.html

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "attachment": {
    "id": "6825595981821404640",
    "download_url": "http://company.lvh.me/attachments/6825595981821404640/token/d58958be54965beb2419ffe273811455d7565fb2f996999efd27b9617c3a4208.download?size=original",
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "content_type": "text/html",
    "file_name": "home_page.html",
    "file_size": 0
  }
}

POST /api/v1/notes/:note_id/attachments

Upload a file to a note (description, theme, etc)

Parameters

Name Description
note_id * Numeric ID of the note the uploaded file should be attached to

POST /api/v1/notes/793547626/attachments

Example CURL command

curl "https://company.aha.io/api/v1/notes/793547626/attachments" -d $'------------XnJLe9ZIbbGUYtzPQJ16u1\r
Content-Disposition: form-data; name="attachment[data]"; filename="sample_plain_text.txt"\r
Content-Type: text/plain\r
Content-Length: 27\r
\r
[uploaded data]\r
------------XnJLe9ZIbbGUYtzPQJ16u1--
' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: multipart/form-data; boundary=----------XnJLe9ZIbbGUYtzPQJ16u1
Accept: application/json
------------XnJLe9ZIbbGUYtzPQJ16u1
Content-Disposition: form-data; name="attachment[data]"; filename="sample_plain_text.txt"
Content-Type: text/plain
Content-Length: 27

[uploaded data]
------------XnJLe9ZIbbGUYtzPQJ16u1--

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "attachment": {
    "id": "6825595982869578478",
    "download_url": "http://company.lvh.me/attachments/6825595982869578478/token/fae4c1ee88f7a3ea5e0e28e04d61ac44e2c93ba559d8646860fa367c7f64d679.download?size=original",
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "content_type": "text/plain",
    "file_name": "sample_plain_text.txt",
    "file_size": 27
  }
}

POST /api/v1/notes/:note_id/attachments

Upload a link to a note (description, theme, etc)

Parameters

Name Description
note_id * Numeric ID of the note the uploaded file should be attached to

POST /api/v1/notes/793547626/attachments

Example CURL command

curl "https://company.aha.io/api/v1/notes/793547626/attachments" -d $'attachment[file_url]=http%3A%2F%2Fwww.aha.io%2F&attachment[content_type]=text%2Fhtml&attachment[file_name]=home_page.html' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: multipart/form-data" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: multipart/form-data
Accept: application/json
attachment[file_url]=http%3A%2F%2Fwww.aha.io%2F&attachment[content_type]=text%2Fhtml&attachment[file_name]=home_page.html

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "attachment": {
    "id": "6825595983876378854",
    "download_url": "http://company.lvh.me/attachments/6825595983876378854/token/1b3f2e4b6bdc95fc715dc74a23f016f406eecbb50a2bf8bbd0f665a3646d0a66.download?size=original",
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "content_type": "text/html",
    "file_name": "home_page.html",
    "file_size": 0
  }
}

DELETE /api/v1/attachments/:attachment_id

Delete an attachment from a note (description, theme, etc)

Parameters

Name Description
attachment_id * Numeric ID of the attachment to be deleted

DELETE /api/v1/attachments/744925247

Example CURL command

curl "https://company.aha.io/api/v1/attachments/744925247" -d $'' -X DELETE \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 204 No Content
  

Base API


GET /api/v1/products

User inactive

GET /api/v1/products

Example CURL command

curl -g "https://company.aha.io/api/v1/products" -X GET \
	-H "Content-Type: application/json" \
	-H "Accept: application/json" \
	-H "Authorization: Bearer ade88990ea8507ed70eff9e918890a12d9f563b3d162e291df1a8d7fe0e7f3b1"

Request

Content-Type: application/json
Accept: application/json
Authorization: Bearer ade88990ea8507ed70eff9e918890a12d9f563b3d162e291df1a8d7fe0e7f3b1

Response

Status: 403 Forbidden
  Content-Type: text/html

GET /api/v1/products

Account lapsed

GET /api/v1/products

Example CURL command

curl -g "https://company.aha.io/api/v1/products" -X GET \
	-H "Content-Type: application/json" \
	-H "Accept: application/json" \
	-H "Authorization: Bearer 0409377d7f2adaf37f84c40d3d621468e0f8198bdbc5657bd8d9f42710dcb9fb"

Request

Content-Type: application/json
Accept: application/json
Authorization: Bearer 0409377d7f2adaf37f84c40d3d621468e0f8198bdbc5657bd8d9f42710dcb9fb

Response

Status: 403 Forbidden
  Content-Type: text/html

GET /api/v1/products

Account cancelled

GET /api/v1/products

Example CURL command

curl -g "https://company.aha.io/api/v1/products" -X GET \
	-H "Content-Type: application/json" \
	-H "Accept: application/json" \
	-H "Authorization: Bearer fd04fa4bedf317c002a982c2fdbedf780370704355a0362381a099e175b95254"

Request

Content-Type: application/json
Accept: application/json
Authorization: Bearer fd04fa4bedf317c002a982c2fdbedf780370704355a0362381a099e175b95254

Response

Status: 403 Forbidden
  Content-Type: text/html

Capacity investments API


GET /api/v1/initiatives/:initiative_id/capacity_investments

Retrieve capacity investments for an initiative

Parameters

Name Description
initiative_id * Numeric ID or key of the initiative to retrieve capacity investments for

GET /api/v1/initiatives/PRJ1-S-1/capacity_investments

Example CURL command

curl -g "https://company.aha.io/api/v1/initiatives/PRJ1-S-1/capacity_investments" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 404 Not Found
  Content-Type: application/json; charset=utf-8
{
  "error": "Record not found."
}

POST /api/v1/initiatives/:initiative_id/capacity_investments

Create a capacity investment on an initiative

Parameters

Name Description
initiative_id * Numeric ID or key of the initiative to create a capacity_investment for
start_date The start date for the capacity investment
end_date The end date for the capacity investment
date_source The date source for the capacity investment, can be one of: manual_dates, capacity_plannable
estimate_source The estimate source for the capacity investment, can be one of: manual_estimate, features, epics

POST /api/v1/initiatives/PRJ1-S-6/capacity_investments

Example CURL command

curl "https://company.aha.io/api/v1/initiatives/PRJ1-S-6/capacity_investments" -d $'{}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "capacity_investment": {
    "id": "6825596003007892245",
    "capacity_scenario_id": "997808419",
    "total": null,
    "estimate_source": "manual_estimate",
    "date_source": "capacity_plannable",
    "start_date": null,
    "end_date": null,
    "initiative": {
      "id": "1042392694",
      "name": "Initiative 3",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/initiatives/PRJ1-S-6",
      "resource": "http://company.aha.io/api/v1/initiatives/PRJ1-S-6"
    },
    "estimate_values": [

    ]
  }
}

POST /api/v1/features/:master_feature_id/capacity_investments

Create a capacity investment on a master feature

Parameters

Name Description
master_feature_id * Numeric ID or key of the master feature to create a capacity_investment for
start_date The start date for the capacity investment
end_date The end date for the capacity investment
date_source The date source for the capacity investment, can be one of: manual_dates, capacity_plannable
estimate_source The estimate source for the capacity investment, can be one of: manual_estimate, features, epics

POST /api/v1/features/PRJ1-1/capacity_investments

Example CURL command

curl "https://company.aha.io/api/v1/features/PRJ1-1/capacity_investments" -d $'{}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "capacity_investment": {
    "id": "6825596003868599585",
    "capacity_scenario_id": "997808419",
    "total": null,
    "estimate_source": "manual_estimate",
    "date_source": "capacity_plannable",
    "start_date": "2019-01-01",
    "end_date": "2019-01-01",
    "feature": {
      "id": "1007868956",
      "reference_num": "PRJ1-1",
      "name": "Feature 1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/features/PRJ1-1",
      "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
      "product_id": 131414752
    },
    "estimate_values": [

    ]
  }
}

POST /api/v1/features/:feature_id/capacity_investments

Create a capacity investment on a feature

Parameters

Name Description
feature_id * Numeric ID or key of the feature to create a capacity_investment for
start_date The start date for the capacity investment
end_date The end date for the capacity investment
date_source The date source for the capacity investment, can be one of: manual_dates, capacity_plannable
estimate_source The estimate source for the capacity investment, can be one of: manual_estimate, features, epics

POST /api/v1/features/PRJ1-1/capacity_investments

Example CURL command

curl "https://company.aha.io/api/v1/features/PRJ1-1/capacity_investments" -d $'{}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "capacity_investment": {
    "id": "6825596004730048587",
    "capacity_scenario_id": "997808419",
    "total": null,
    "estimate_source": "manual_estimate",
    "date_source": "capacity_plannable",
    "start_date": "2019-01-01",
    "end_date": "2019-01-01",
    "feature": {
      "id": "1007868956",
      "reference_num": "PRJ1-1",
      "name": "Feature 1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/features/PRJ1-1",
      "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
      "product_id": 131414752
    },
    "estimate_values": [

    ]
  }
}

GET /api/v1/products/:product_id/capacity_investments

Retrieve capacity investments for a product

Parameters

Name Description
product_id * Numeric ID or key of the product to retrieve capacity investments for

GET /api/v1/products/PRJ1/capacity_investments

Example CURL command

curl -g "https://company.aha.io/api/v1/products/PRJ1/capacity_investments" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "capacity_investments": [
    {
      "id": "756888381",
      "capacity_scenario_id": "997808419",
      "total": null
    },
    {
      "id": "873751177",
      "capacity_scenario_id": "997808419",
      "total": "100.0"
    }
  ],
  "pagination": {
    "total_records": 2,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/initiatives/:initiative_id/capacity_investments

Retrieve capacity investments for an initiative

Parameters

Name Description
initiative_id * Numeric ID or key of the initiative to retrieve capacity investments for

GET /api/v1/initiatives/PRJ1-S-1/capacity_investments

Example CURL command

curl -g "https://company.aha.io/api/v1/initiatives/PRJ1-S-1/capacity_investments" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "capacity_investments": [
    {
      "id": "756888381",
      "capacity_scenario_id": "997808419",
      "total": null
    }
  ],
  "pagination": {
    "total_records": 1,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/master_features/:master_feature_id/capacity_investments

Retrieve capacity investments for a master feature

Parameters

Name Description
master_feature_id * Numeric ID or key of the master feature to retrieve capacity investments for

GET /api/v1/master_features/PRJ1-E-1/capacity_investments

Example CURL command

curl -g "https://company.aha.io/api/v1/master_features/PRJ1-E-1/capacity_investments" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "capacity_investments": [
    {
      "id": "6825596006487053361",
      "capacity_scenario_id": "997808419",
      "total": null
    }
  ],
  "pagination": {
    "total_records": 1,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/features/:feature_id/capacity_investments

Retrieve capacity investments for a feature

Parameters

Name Description
feature_id * Numeric ID or key of the feature to retrieve capacity investments for

GET /api/v1/features/PRJ1-1/capacity_investments

Example CURL command

curl -g "https://company.aha.io/api/v1/features/PRJ1-1/capacity_investments" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "capacity_investments": [
    {
      "id": "6825596007440843900",
      "capacity_scenario_id": "997808419",
      "total": null
    }
  ],
  "pagination": {
    "total_records": 1,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/capacity_investments/:id

Retrieve capacity investment details

Parameters

Name Description
id * Numeric ID of the capacity investment to retrieve

GET /api/v1/capacity_investments/6825596008404248438

Example CURL command

curl -g "https://company.aha.io/api/v1/capacity_investments/6825596008404248438" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "capacity_investment": {
    "id": "6825596008404248438",
    "capacity_scenario_id": "997808419",
    "total": "50.0",
    "estimate_source": "manual_estimate",
    "date_source": "capacity_plannable",
    "start_date": "2019-01-01",
    "end_date": "2019-01-01",
    "feature": {
      "id": "1007868956",
      "reference_num": "PRJ1-1",
      "name": "Feature 1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/features/PRJ1-1",
      "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
      "product_id": 131414752
    },
    "estimate_values": [
      {
        "id": "6825596009283924094",
        "team_id": 563889676,
        "period_start": "2019-01-01",
        "total": "15.0",
        "computed": false,
        "ignored": false
      },
      {
        "id": "6825596009530710426",
        "team_id": 563889676,
        "period_start": "2019-01-01",
        "total": "20.0",
        "computed": false,
        "ignored": false
      },
      {
        "id": "6825596009329829559",
        "team_id": 563889676,
        "period_start": null,
        "total": "35.0",
        "computed": true,
        "ignored": false
      },
      {
        "id": "6825596008636648034",
        "team_id": 949295028,
        "period_start": "2019-01-01",
        "total": "5.0",
        "computed": false,
        "ignored": false
      },
      {
        "id": "6825596009018401350",
        "team_id": 949295028,
        "period_start": "2019-01-01",
        "total": "10.0",
        "computed": false,
        "ignored": false
      },
      {
        "id": "6825596008708522683",
        "team_id": 949295028,
        "period_start": null,
        "total": "15.0",
        "computed": true,
        "ignored": false
      },
      {
        "id": "6825596008932877548",
        "team_id": null,
        "period_start": "2019-01-01",
        "total": "5.0",
        "computed": true,
        "ignored": false
      },
      {
        "id": "6825596009162233863",
        "team_id": null,
        "period_start": "2019-01-01",
        "total": "25.0",
        "computed": true,
        "ignored": false
      },
      {
        "id": "6825596009666521082",
        "team_id": null,
        "period_start": "2019-01-01",
        "total": "20.0",
        "computed": true,
        "ignored": false
      },
      {
        "id": "6825596008743248019",
        "team_id": null,
        "period_start": null,
        "total": "50.0",
        "computed": true,
        "ignored": false
      }
    ]
  }
}

PUT /api/v1/capacity_investments/:id

Update a capacity investment

Parameters

Name Description
id * Numeric ID of capacity investment to be edited
start_date The start date for the capacity investment
end_date The end date for the capacity investment
date_source The date source for the capacity investment, can be one of: manual_dates, capacity_plannable
estimate_source The estimate source for the capacity investment, can be one of: manual_estimate, features, epics

PUT /api/v1/capacity_investments/756888381

Example CURL command

curl "https://company.aha.io/api/v1/capacity_investments/756888381" -d $'{"capacity_investment":{"date_source":"manual_dates","start_date":"2019-01-01","end_date":"2019-01-01"}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "capacity_investment": {
    "date_source": "manual_dates",
    "start_date": "2019-01-01",
    "end_date": "2019-01-01"
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "capacity_investment": {
    "id": "756888381",
    "capacity_scenario_id": "997808419",
    "total": null,
    "estimate_source": "manual_estimate",
    "date_source": "manual_dates",
    "start_date": "2019-01-01",
    "end_date": "2019-01-01",
    "initiative": {
      "id": "423077122",
      "name": "Initiative 1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/initiatives/PRJ1-S-1",
      "resource": "http://company.aha.io/api/v1/initiatives/PRJ1-S-1"
    },
    "estimate_values": [

    ]
  }
}

Capacity scenarios API


GET /api/v1/capacity_scenarios

retrieve capacity scenarios

GET /api/v1/capacity_scenarios

Example CURL command

curl -g "https://company.aha.io/api/v1/capacity_scenarios" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 404 Not Found
  Content-Type: application/json; charset=utf-8
{
  "error": "Record not found."
}

GET /api/v1/capacity_scenarios/:id

retrieve capacity scenarios

Parameters

Name Description
id id

GET /api/v1/capacity_scenarios/997808419

Example CURL command

curl -g "https://company.aha.io/api/v1/capacity_scenarios/997808419" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "capacity_scenario": {
    "id": 997808419,
    "name": "Default test scenario",
    "planning_interval": "month",
    "planning_start_date": "2019-01-01",
    "planning_end_date": "2019-01-01",
    "estimate_value_layout": "team_by_time",
    "data_entry_units": "headcount"
  }
}

GET /api/v1/capacity_scenarios/picker

retrieve capacity scenarios

Parameters

Name Description
id id

GET /api/v1/capacity_scenarios/picker?id=997808419

Example CURL command

curl -g "https://company.aha.io/api/v1/capacity_scenarios/picker?id=997808419" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "options": [
    {
      "text": "Default test scenario",
      "value": 997808419
    },
    {
      "text": "Second test scenario",
      "value": 454855257
    }
  ]
}

GET /api/v1/capacity_scenarios/picker

retrieve capacity scenarios

Parameters

Name Description
id id

GET /api/v1/capacity_scenarios/picker?id=997808419

Example CURL command

curl -g "https://company.aha.io/api/v1/capacity_scenarios/picker?id=997808419" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "options": [
    {
      "text": "Default test scenario",
      "value": 997808419
    },
    {
      "text": "Second test scenario",
      "value": 454855257
    }
  ]
}

Comments API


Comments can be added to and listed as a sub-resource on any resource that supports them. These resources support comments:

They can be listed product-wide, or retrieved from anywhere in the system using the root comments resource.

POST /api/v1/features/:feature_id/comments

Create a comment for a feature

Parameters

Name Description
feature_id * Numeric ID or key of the feature the comment should be created for

POST /api/v1/features/1007868956/comments

Example CURL command

curl "https://company.aha.io/api/v1/features/1007868956/comments" -d $'{"comment":{"body":"\u003cp\u003eThis is the comment body for a feature.\u003c/p\u003e"}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "comment": {
    "body": "<p>This is the comment body for a feature.</p>"
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "comment": {
    "id": "6825596012871958304",
    "body": "<p>This is the comment body for a feature.</p>",
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z"
    },
    "attachments": [

    ],
    "url": "http://company.aha.io/comments/6825596012871958304",
    "resource": "http://company.aha.io/api/v1/comments/6825596012871958304",
    "commentable": {
      "type": "Feature",
      "id": "1007868956",
      "url": "http://company.aha.io/features/PRJ1-1",
      "product_id": 131414752,
      "resource": "http://company.aha.io/api/v1/features/PRJ1-1"
    }
  }
}

POST /api/v1/master_features/:master_feature_id/comments

Create a comment for a master feature

Parameters

Name Description
master_feature_id * Numeric ID or key of the master feature feature the comment should be created for

POST /api/v1/master_features/999605892/comments

Example CURL command

curl "https://company.aha.io/api/v1/master_features/999605892/comments" -d $'{"comment":{"body":"\u003cp\u003eThis is the comment body for a master feature.\u003c/p\u003e"}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "comment": {
    "body": "<p>This is the comment body for a master feature.</p>"
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "comment": {
    "id": "6825596013799645796",
    "body": "<p>This is the comment body for a master feature.</p>",
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z"
    },
    "attachments": [

    ],
    "url": "http://company.aha.io/comments/6825596013799645796",
    "resource": "http://company.aha.io/api/v1/comments/6825596013799645796",
    "commentable": {
      "type": "Epic",
      "id": "999605892",
      "url": "http://company.aha.io/epics/PRJ1-E-1",
      "product_id": 131414752,
      "resource": "http://company.aha.io/api/v1/epics/PRJ1-E-1"
    }
  }
}

POST /api/v1/requirements/:requirement_id/comments

Create a comment for a requirement

Parameters

Name Description
requirement_id * Numeric ID or key of the requirement the comment should be created for

POST /api/v1/requirements/483368544/comments

Example CURL command

curl "https://company.aha.io/api/v1/requirements/483368544/comments" -d $'{"comment":{"body":"\u003cp\u003eThis is the comment body for a requirement.\u003c/p\u003e"}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "comment": {
    "body": "<p>This is the comment body for a requirement.</p>"
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "comment": {
    "id": "6825596014642416732",
    "body": "<p>This is the comment body for a requirement.</p>",
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z"
    },
    "attachments": [

    ],
    "url": "http://company.aha.io/comments/6825596014642416732",
    "resource": "http://company.aha.io/api/v1/comments/6825596014642416732",
    "commentable": {
      "type": "Requirement",
      "id": "483368544",
      "url": "http://company.aha.io/requirements/PRJ1-1-1",
      "product_id": 131414752,
      "resource": "http://company.aha.io/api/v1/requirements/PRJ1-1-1"
    }
  }
}

POST /api/v1/ideas/:idea_id/comments

Create a private comment for an idea

Parameters

Name Description
idea_id * Numeric ID or key of the idea the comment should be created for

POST /api/v1/ideas/58056975/comments

Example CURL command

curl "https://company.aha.io/api/v1/ideas/58056975/comments" -d $'{"comment":{"body":"\u003cp\u003eThis is the comment body for an idea.\u003c/p\u003e"}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "comment": {
    "body": "<p>This is the comment body for an idea.</p>"
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "comment": {
    "id": "6825596016181105752",
    "body": "<p>This is the comment body for an idea.</p>",
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z"
    },
    "attachments": [

    ],
    "url": "http://company.aha.io/comments/6825596016181105752",
    "resource": "http://company.aha.io/api/v1/comments/6825596016181105752",
    "commentable": {
      "type": "Ideas::Idea",
      "id": "58056975",
      "url": "http://company.aha.io/ideas/ideas/PRJ1-I-1",
      "product_id": 131414752,
      "resource": "http://company.aha.io/api/v1/ideas/ideas/PRJ1-I-1"
    }
  }
}

POST /api/v1/initiatives/:initiative_id/comments

Create a comment for an initiative

Parameters

Name Description
initiative_id * Numeric ID or key of the initiative the comment should be created for

POST /api/v1/initiatives/423077122/comments

Example CURL command

curl "https://company.aha.io/api/v1/initiatives/423077122/comments" -d $'{"comment":{"body":"\u003cp\u003eThis is the comment body for an initiative.\u003c/p\u003e"}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "comment": {
    "body": "<p>This is the comment body for an initiative.</p>"
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "comment": {
    "id": "6825596016669742476",
    "body": "<p>This is the comment body for an initiative.</p>",
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z"
    },
    "attachments": [

    ],
    "url": "http://company.aha.io/comments/6825596016669742476",
    "resource": "http://company.aha.io/api/v1/comments/6825596016669742476",
    "commentable": {
      "type": "Initiative",
      "id": "423077122",
      "url": "http://company.aha.io/initiatives/PRJ1-S-1",
      "product_id": 131414752,
      "resource": "http://company.aha.io/api/v1/initiatives/PRJ1-S-1"
    }
  }
}

POST /api/v1/goals/:goal_id/comments

Create a comment for a goal

Parameters

Name Description
goal_id * Numeric ID or key of the goal the comment should be created for

POST /api/v1/goals/602095703/comments

Example CURL command

curl "https://company.aha.io/api/v1/goals/602095703/comments" -d $'{"comment":{"body":"\u003cp\u003eThis is the comment body for a goal.\u003c/p\u003e"}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "comment": {
    "body": "<p>This is the comment body for a goal.</p>"
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "comment": {
    "id": "6825596017258774806",
    "body": "<p>This is the comment body for a goal.</p>",
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z"
    },
    "attachments": [

    ],
    "url": "http://company.aha.io/comments/6825596017258774806",
    "resource": "http://company.aha.io/api/v1/comments/6825596017258774806",
    "commentable": {
      "type": "StrategicImperative",
      "id": "602095703",
      "url": "http://company.aha.io/strategic_imperatives/DEMOENT-G-1",
      "product_id": 131414752,
      "resource": "http://company.aha.io/api/v1/goals/DEMOENT-G-1"
    }
  }
}

POST /api/v1/release_phases/:release_phase_id/comments

Create a comment for a release phase

Parameters

Name Description
release_phase_id * Numeric ID or key of the release phase the comment should be created for

POST /api/v1/release_phases/20526005/comments

Example CURL command

curl "https://company.aha.io/api/v1/release_phases/20526005/comments" -d $'{"comment":{"body":"\u003cp\u003eThis is the comment body for a release phase.\u003c/p\u003e"}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "comment": {
    "body": "<p>This is the comment body for a release phase.</p>"
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "comment": {
    "id": "6825596017835929941",
    "body": "<p>This is the comment body for a release phase.</p>",
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z"
    },
    "attachments": [

    ],
    "url": "http://company.aha.io/comments/6825596017835929941",
    "resource": "http://company.aha.io/api/v1/comments/6825596017835929941",
    "commentable": {
      "type": "ReleasePhase",
      "id": "20526005",
      "url": "http://company.aha.io/release_phases/20526005",
      "resource": "http://company.aha.io/api/v1/release_phases/20526005"
    }
  }
}

GET /api/v1/comments/:id

Get a specific comment

Parameters

Name Description
id * Numberic ID of the comment to be retrieved

GET /api/v1/comments/781701978

Example CURL command

curl -g "https://company.aha.io/api/v1/comments/781701978" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "comment": {
    "id": "781701978",
    "body": "Comment on feature",
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z"
    },
    "attachments": [
      {
        "id": "822785180",
        "download_url": "http://company.lvh.me/attachments/822785180/token/9059ed451f0db369e7c6f38f07afae5b7838fba53156b4658392329b14df5e24.download?size=original",
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "content_type": "text/plain",
        "file_name": "uploaded_file_name.txt",
        "file_size": 123
      },
      {
        "id": "180276963",
        "download_url": "http://company.lvh.me/attachments/180276963/token/0dd457c898bce57f9fcb2d206eb8e6a3311e0fc1451b93d3a0b4f7e9d3181cb2.download?size=original",
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "content_type": "text/plain",
        "file_name": "uploaded_file_name.txt",
        "file_size": 123
      }
    ],
    "url": "http://company.aha.io/comments/781701978",
    "resource": "http://company.aha.io/api/v1/comments/781701978",
    "commentable": {
      "type": "Feature",
      "id": "1007868956",
      "url": "http://company.aha.io/features/PRJ1-1",
      "product_id": 131414752,
      "resource": "http://company.aha.io/api/v1/features/PRJ1-1"
    }
  }
}

GET /api/v1/products/:project_id/comments

Get all comments on a product

Parameters

Name Description
project_id * Numeric ID of the product to get comments for

GET /api/v1/products/131414752/comments

Example CURL command

curl -g "https://company.aha.io/api/v1/products/131414752/comments" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "comments": [
    {
      "id": "55160124",
      "body": "Comment on project",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "user": {
        "id": "1020675218",
        "name": "Mary Humpty",
        "email": "no-reply@aha.io",
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z"
      },
      "attachments": [

      ],
      "url": "http://company.aha.io/comments/55160124",
      "resource": "http://company.aha.io/api/v1/comments/55160124",
      "commentable": {
        "type": "Task",
        "id": "748715293",
        "url": "http://company.aha.io/tasks/748715293",
        "product_id": null,
        "resource": "http://company.aha.io/api/v1/tasks/748715293"
      }
    },
    {
      "id": "933135074",
      "body": "Comment on project",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "user": {
        "id": "1020675218",
        "name": "Mary Humpty",
        "email": "no-reply@aha.io",
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z"
      },
      "attachments": [
        {
          "id": "744925247",
          "download_url": "http://company.lvh.me/attachments/744925247/token/464bebc006e3571a05170d5fe5c4a2917564bf6fd4c83c623d57d579f93cdf87.download?size=original",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "content_type": "text/plain",
          "file_name": "uploaded_file_name.txt",
          "file_size": 123
        },
        {
          "id": "896530823",
          "download_url": "http://account-with-enabled-services.lvh.me/attachments/896530823/token/aaabbbccc111223.download?size=original",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "content_type": "application/pdf",
          "file_name": "google_doc.pdf",
          "file_size": null
        },
        {
          "id": "1005425561",
          "download_url": "http://account-with-enabled-services.lvh.me/attachments/1005425561/token/2a5bfca2b43c7d14b502414c55bd8c7027b698aa16711cf74a6d9a3f8080d30a.download?size=original",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "content_type": "application/pdf",
          "file_name": "dropbox_doc.pdf",
          "file_size": 677794
        },
        {
          "id": "793976649",
          "download_url": "http://account-with-enabled-services.lvh.me/attachments/793976649/token/5844ad2a5ce9d09ed479c3fa4b371cf3a28eeca7168be89fb8c6a5bc440fe0d4.download?size=original",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "content_type": "application/pdf",
          "file_name": "box_doc.pdf",
          "file_size": 677794
        },
        {
          "id": "109125418",
          "download_url": "http://company.lvh.me/attachments/109125418/token/2994627db74587d75a69edd5680529d938e49174d471dd0e80f989828b732fa0.download?size=original",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "content_type": "application/pdf",
          "file_name": "google_doc.pdf",
          "file_size": 67794
        },
        {
          "id": "221084308",
          "download_url": "http://company.lvh.me/attachments/221084308/token/f4d841eb1d047796efcdcfca7fd5a1c21112387a6ac60623402a5262a19a9e92.download?size=original",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "content_type": "image/png",
          "file_name": "Mockup.png",
          "file_size": 123
        },
        {
          "id": "229957526",
          "download_url": "http://company.lvh.me/attachments/229957526/token/aaabbbccc111224.download?size=original",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "content_type": "image/png",
          "file_name": "not-a-mockup.png",
          "file_size": 123
        }
      ],
      "url": "http://company.aha.io/comments/933135074",
      "resource": "http://company.aha.io/api/v1/comments/933135074",
      "commentable": {
        "type": "Project",
        "id": "131414752",
        "url": "http://company.aha.io/projects/PRJ1",
        "resource": "http://company.aha.io/api/v1/products/PRJ1"
      }
    },
    {
      "id": "781701978",
      "body": "Comment on feature",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "user": {
        "id": "1020675218",
        "name": "Mary Humpty",
        "email": "no-reply@aha.io",
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z"
      },
      "attachments": [
        {
          "id": "822785180",
          "download_url": "http://company.lvh.me/attachments/822785180/token/0416bab5d4b585cede55d6139e9ca4f8020e7e2ea8b44f36294ad62fd32c2fe9.download?size=original",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "content_type": "text/plain",
          "file_name": "uploaded_file_name.txt",
          "file_size": 123
        },
        {
          "id": "180276963",
          "download_url": "http://company.lvh.me/attachments/180276963/token/1f897360a53b1ffd3bc761e3c804047f167caa124d9b65d68c191032ef9f3769.download?size=original",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "content_type": "text/plain",
          "file_name": "uploaded_file_name.txt",
          "file_size": 123
        }
      ],
      "url": "http://company.aha.io/comments/781701978",
      "resource": "http://company.aha.io/api/v1/comments/781701978",
      "commentable": {
        "type": "Feature",
        "id": "1007868956",
        "url": "http://company.aha.io/features/PRJ1-1",
        "product_id": 131414752,
        "resource": "http://company.aha.io/api/v1/features/PRJ1-1"
      }
    },
    {
      "id": "428925905",
      "body": "Comment on release",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "user": {
        "id": "601067208",
        "name": "Jeremy Smith",
        "email": "no-reply@aha.io",
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z"
      },
      "attachments": [

      ],
      "url": "http://company.aha.io/comments/428925905",
      "resource": "http://company.aha.io/api/v1/comments/428925905",
      "commentable": {
        "type": "Release",
        "id": "278327321",
        "url": "http://company.aha.io/releases/PRJ1-R-1",
        "product_id": 131414752,
        "resource": "http://company.aha.io/api/v1/releases/PRJ1-R-1"
      }
    },
    {
      "id": "133461614",
      "body": "Comment on initiative",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "user": {
        "id": "601067208",
        "name": "Jeremy Smith",
        "email": "no-reply@aha.io",
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z"
      },
      "attachments": [

      ],
      "url": "http://company.aha.io/comments/133461614",
      "resource": "http://company.aha.io/api/v1/comments/133461614",
      "commentable": {
        "type": "Initiative",
        "id": "423077122",
        "url": "http://company.aha.io/initiatives/PRJ1-S-1",
        "product_id": 131414752,
        "resource": "http://company.aha.io/api/v1/initiatives/PRJ1-S-1"
      }
    },
    {
      "id": "821249787",
      "body": "Comment on goal",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "user": {
        "id": "601067208",
        "name": "Jeremy Smith",
        "email": "no-reply@aha.io",
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z"
      },
      "attachments": [

      ],
      "url": "http://company.aha.io/comments/821249787",
      "resource": "http://company.aha.io/api/v1/comments/821249787",
      "commentable": {
        "type": "StrategicImperative",
        "id": "602095703",
        "url": "http://company.aha.io/strategic_imperatives/DEMOENT-G-1",
        "product_id": 131414752,
        "resource": "http://company.aha.io/api/v1/goals/DEMOENT-G-1"
      }
    },
    {
      "id": "110125740",
      "body": "Comment on competitor 1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "user": {
        "id": "1020675218",
        "name": "Mary Humpty",
        "email": "no-reply@aha.io",
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z"
      },
      "attachments": [

      ],
      "url": "http://company.aha.io/comments/110125740",
      "resource": "http://company.aha.io/api/v1/comments/110125740",
      "commentable": {
        "type": "Competitor",
        "id": "892399625",
        "url": "http://company.aha.io/competitors/892399625",
        "product_id": 131414752,
        "resource": "http://company.aha.io/api/v1/competitors/892399625"
      }
    },
    {
      "id": "340318108",
      "body": "This feature is integrated",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "user": {
        "id": "1020675218",
        "name": "Mary Humpty",
        "email": "no-reply@aha.io",
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z"
      },
      "attachments": [

      ],
      "url": "http://company.aha.io/comments/340318108",
      "resource": "http://company.aha.io/api/v1/comments/340318108",
      "commentable": {
        "type": "Feature",
        "id": "303873333",
        "url": "http://company.aha.io/features/PRJ1-3",
        "product_id": 131414752,
        "resource": "http://company.aha.io/api/v1/features/PRJ1-3"
      }
    },
    {
      "id": "971503243",
      "body": "This is a requirement comment",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "user": {
        "id": "1020675218",
        "name": "Mary Humpty",
        "email": "no-reply@aha.io",
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z"
      },
      "attachments": [

      ],
      "url": "http://company.aha.io/comments/971503243",
      "resource": "http://company.aha.io/api/v1/comments/971503243",
      "commentable": {
        "type": "Requirement",
        "id": "483368544",
        "url": "http://company.aha.io/requirements/PRJ1-1-1",
        "product_id": 131414752,
        "resource": "http://company.aha.io/api/v1/requirements/PRJ1-1-1"
      }
    },
    {
      "id": "714777635",
      "body": "An annotation comment",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "user": {
        "id": "1049303076",
        "name": "George Gently",
        "email": "no-reply@aha.io",
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z"
      },
      "attachments": [

      ],
      "url": "http://company.aha.io/comments/714777635",
      "resource": "http://company.aha.io/api/v1/comments/714777635",
      "commentable": {
        "type": "Annotation",
        "id": "345680906",
        "url": "http://company.aha.io/annotations/345680906"
      }
    },
    {
      "id": "779056158",
      "body": "An annotation comment",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "user": {
        "id": "1049303076",
        "name": "George Gently",
        "email": "no-reply@aha.io",
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z"
      },
      "attachments": [

      ],
      "url": "http://company.aha.io/comments/779056158",
      "resource": "http://company.aha.io/api/v1/comments/779056158",
      "commentable": {
        "type": "Annotation",
        "id": "594874923",
        "url": "http://company.aha.io/annotations/594874923"
      }
    }
  ],
  "pagination": {
    "total_records": 11,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/features/:feature_id/comments

Get all comments on a feature

Parameters

Name Description
feature_id * Numeric ID of the feature to get comments for

GET /api/v1/features/1007868956/comments

Example CURL command

curl -g "https://company.aha.io/api/v1/features/1007868956/comments" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "comments": [
    {
      "id": "781701978",
      "body": "Comment on feature",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "user": {
        "id": "1020675218",
        "name": "Mary Humpty",
        "email": "no-reply@aha.io",
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z"
      },
      "attachments": [
        {
          "id": "822785180",
          "download_url": "http://company.lvh.me/attachments/822785180/token/136e890484ccc9e06d6ba8477a4ce4e412bc3846f437ba42f9acb8c70c46f270.download?size=original",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "content_type": "text/plain",
          "file_name": "uploaded_file_name.txt",
          "file_size": 123
        },
        {
          "id": "180276963",
          "download_url": "http://company.lvh.me/attachments/180276963/token/e045e0a29e2c2c00c3ecb54019a253a7fb2b995fc8e1d5b810f78270b1033c5c.download?size=original",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "content_type": "text/plain",
          "file_name": "uploaded_file_name.txt",
          "file_size": 123
        }
      ],
      "url": "http://company.aha.io/comments/781701978",
      "resource": "http://company.aha.io/api/v1/comments/781701978",
      "commentable": {
        "type": "Feature",
        "id": "1007868956",
        "url": "http://company.aha.io/features/PRJ1-1",
        "product_id": 131414752,
        "resource": "http://company.aha.io/api/v1/features/PRJ1-1"
      }
    }
  ],
  "pagination": {
    "total_records": 1,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/requirements/:requirement_id/comments

Get all comments on a requirement

Parameters

Name Description
requirement_id * Numeric ID of the requirement to get comments for

GET /api/v1/requirements/483368544/comments

Example CURL command

curl -g "https://company.aha.io/api/v1/requirements/483368544/comments" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "comments": [
    {
      "id": "971503243",
      "body": "This is a requirement comment",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "user": {
        "id": "1020675218",
        "name": "Mary Humpty",
        "email": "no-reply@aha.io",
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z"
      },
      "attachments": [

      ],
      "url": "http://company.aha.io/comments/971503243",
      "resource": "http://company.aha.io/api/v1/comments/971503243",
      "commentable": {
        "type": "Requirement",
        "id": "483368544",
        "url": "http://company.aha.io/requirements/PRJ1-1-1",
        "product_id": 131414752,
        "resource": "http://company.aha.io/api/v1/requirements/PRJ1-1-1"
      }
    }
  ],
  "pagination": {
    "total_records": 1,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/ideas/:idea_id/comments

Get all comments on an idea

Parameters

Name Description
idea_id * Numeric ID of the idea to get comments for

GET /api/v1/ideas/58056975/comments

Example CURL command

curl -g "https://company.aha.io/api/v1/ideas/58056975/comments" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "comments": [

  ],
  "pagination": {
    "total_records": 0,
    "total_pages": 0,
    "current_page": 1
  }
}

GET /api/v1/initiatives/:initiative_id/comments

Get all comments on an initiative

Parameters

Name Description
initiative_id * Numeric ID of the initiative to get comments for

GET /api/v1/initiatives/423077122/comments

Example CURL command

curl -g "https://company.aha.io/api/v1/initiatives/423077122/comments" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "comments": [
    {
      "id": "133461614",
      "body": "Comment on initiative",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "user": {
        "id": "601067208",
        "name": "Jeremy Smith",
        "email": "no-reply@aha.io",
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z"
      },
      "attachments": [

      ],
      "url": "http://company.aha.io/comments/133461614",
      "resource": "http://company.aha.io/api/v1/comments/133461614",
      "commentable": {
        "type": "Initiative",
        "id": "423077122",
        "url": "http://company.aha.io/initiatives/PRJ1-S-1",
        "product_id": 131414752,
        "resource": "http://company.aha.io/api/v1/initiatives/PRJ1-S-1"
      }
    }
  ],
  "pagination": {
    "total_records": 1,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/goals/:goal_id/comments

Get all comments on a goal

Parameters

Name Description
goal_id * Numeric ID of the goal to get comments for

GET /api/v1/goals/602095703/comments

Example CURL command

curl -g "https://company.aha.io/api/v1/goals/602095703/comments" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "comments": [
    {
      "id": "821249787",
      "body": "Comment on goal",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "user": {
        "id": "601067208",
        "name": "Jeremy Smith",
        "email": "no-reply@aha.io",
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z"
      },
      "attachments": [

      ],
      "url": "http://company.aha.io/comments/821249787",
      "resource": "http://company.aha.io/api/v1/comments/821249787",
      "commentable": {
        "type": "StrategicImperative",
        "id": "602095703",
        "url": "http://company.aha.io/strategic_imperatives/DEMOENT-G-1",
        "product_id": 131414752,
        "resource": "http://company.aha.io/api/v1/goals/DEMOENT-G-1"
      }
    }
  ],
  "pagination": {
    "total_records": 1,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/release_phases/:release_phase_id/comments

Get all comments on a release phase

Parameters

Name Description
release_phase_id * Numeric ID of the release phase to get comments for

GET /api/v1/release_phases/20526005/comments

Example CURL command

curl -g "https://company.aha.io/api/v1/release_phases/20526005/comments" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "comments": [

  ],
  "pagination": {
    "total_records": 0,
    "total_pages": 0,
    "current_page": 1
  }
}

POST /api/v1/features/:feature_id/comments

Create a comment for a feature on behalf of another user

Parameters

Name Description
feature_id * Numeric ID or key of the feature the comment should be created for

POST /api/v1/features/1007868956/comments

Example CURL command

curl "https://company.aha.io/api/v1/features/1007868956/comments" -d $'{"comment":{"body":"\u003cp\u003eThis is the comment body for a feature.\u003c/p\u003e","user":{"email":"no-reply@aha.io"}}}' -X POST \
	-H "Authorization: Bearer 584b6d6b83405011f8c6903d2379f4afdf824cef867db391b7bcb5995f603a76" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 584b6d6b83405011f8c6903d2379f4afdf824cef867db391b7bcb5995f603a76
Content-Type: application/json
Accept: application/json
{
  "comment": {
    "body": "<p>This is the comment body for a feature.</p>",
    "user": {
      "email": "no-reply@aha.io"
    }
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "comment": {
    "id": "6825596024407285499",
    "body": "<p>This is the comment body for a feature.</p>",
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z"
    },
    "attachments": [

    ],
    "url": "http://company.aha.io/comments/6825596024407285499",
    "resource": "http://company.aha.io/api/v1/comments/6825596024407285499",
    "commentable": {
      "type": "Feature",
      "id": "1007868956",
      "url": "http://company.aha.io/features/PRJ1-1",
      "product_id": 131414752,
      "resource": "http://company.aha.io/api/v1/features/PRJ1-1"
    }
  }
}

PUT /api/v1/comments/:id

Update a comment

Parameters

Name Description
id * Numeric ID, or key of the comment to be edited

PUT /api/v1/comments/781701978

Example CURL command

curl "https://company.aha.io/api/v1/comments/781701978" -d $'{"comment":{"body":"\u003cp\u003eUpdated comment body.\u003c/p\u003e"}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "comment": {
    "body": "<p>Updated comment body.</p>"
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "comment": {
    "id": "781701978",
    "body": "<p>Updated comment body.</p>",
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z"
    },
    "attachments": [
      {
        "id": "822785180",
        "download_url": "http://company.lvh.me/attachments/822785180/token/2478b3c001a96520cbe6a55040d87a1378426421d8ae0de5c73cd77e28f52edc.download?size=original",
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "content_type": "text/plain",
        "file_name": "uploaded_file_name.txt",
        "file_size": 123
      },
      {
        "id": "180276963",
        "download_url": "http://company.lvh.me/attachments/180276963/token/277718d9d66b3475b1e3427efe4cc67b70d6b360dde812838ebf192999d1db74.download?size=original",
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "content_type": "text/plain",
        "file_name": "uploaded_file_name.txt",
        "file_size": 123
      }
    ],
    "url": "http://company.aha.io/comments/781701978",
    "resource": "http://company.aha.io/api/v1/comments/781701978",
    "commentable": {
      "type": "Feature",
      "id": "1007868956",
      "url": "http://company.aha.io/features/PRJ1-1",
      "product_id": 131414752,
      "resource": "http://company.aha.io/api/v1/features/PRJ1-1"
    }
  }
}

DELETE /api/v1/comments/:id

Delete comment

Parameters

Name Description
id * Numeric ID of the comment to be deleted

DELETE /api/v1/comments/55160124

Example CURL command

curl "https://company.aha.io/api/v1/comments/55160124" -d $'' -X DELETE \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 204 No Content
  

Competitors API


GET /api/v1/products/:product_id/competitors

Get a list of all of the competitors in a product

Parameters

Name Description
product_id * Numeric ID, or key of the product to retrieve competitors for

GET /api/v1/products/PRJ1/competitors

Example CURL command

curl -g "https://company.aha.io/api/v1/products/PRJ1/competitors" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "competitors": [
    {
      "id": "457085224",
      "name": "JIRA",
      "created_at": "2019-01-01T00:00:00.000Z"
    },
    {
      "id": "892399625",
      "name": "ProductPlan",
      "created_at": "2019-01-01T00:00:00.000Z"
    },
    {
      "id": "741974453",
      "name": "Roadmunk",
      "created_at": "2019-01-01T00:00:00.000Z"
    }
  ],
  "pagination": {
    "total_records": 3,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/competitors/:id

Get specific competitor

Parameters

Name Description
id * Numeric ID of the competitor to be retrieved

GET /api/v1/competitors/892399625

Example CURL command

curl -g "https://company.aha.io/api/v1/competitors/892399625" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "competitor": {
    "id": "892399625",
    "name": "ProductPlan",
    "color": 29647,
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "url": "http://company.aha.io/competitors/892399625",
    "resource": "http://company.aha.io/competitors/892399625",
    "custom_fields": [
      {
        "key": "revenue",
        "name": "Revenue",
        "value": "300.0",
        "type": "number"
      }
    ],
    "comments_count": 1
  }
}

GET /api/v1/competitors

Search for competitors by name

Parameters

Name Description
q Sub-string to match against competitor name

GET /api/v1/competitors?q=Roadmunk

Example CURL command

curl -g "https://company.aha.io/api/v1/competitors?q=Roadmunk" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "competitors": [
    {
      "id": "741974453",
      "name": "Roadmunk",
      "created_at": "2019-01-01T00:00:00.000Z"
    }
  ],
  "pagination": {
    "total_records": 1,
    "total_pages": 1,
    "current_page": 1
  }
}

POST /api/v1/products/:product_id/competitors

Create a competitor

Parameters

Name Description
product_id * Numeric ID, or key of the product to create the competitor in
name * Name of the competitor
color * Hex color of the competitor in the Aha! UI

POST /api/v1/products/PRJ1/competitors

Example CURL command

curl "https://company.aha.io/api/v1/products/PRJ1/competitors" -d $'{"competitor":{"name":"Trello","color":29647}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "competitor": {
    "name": "Trello",
    "color": 29647
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "competitor": {
    "id": "6825596028328020051",
    "name": "Trello",
    "color": 29647,
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "url": "http://company.aha.io/competitors/6825596028328020051",
    "resource": "http://company.aha.io/competitors/6825596028328020051",
    "custom_fields": [

    ],
    "comments_count": 0
  }
}

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

Update a competitor

Parameters

Name Description
product_id * Numeric ID, or key of the product to create the competitor in
id * Numeric ID, or key of the competitor to be updated
name Name of the competitor
color Hex color of the competitor in the Aha! UI

PUT /api/v1/products/PRJ1/competitors/892399625

Example CURL command

curl "https://company.aha.io/api/v1/products/PRJ1/competitors/892399625" -d $'{"competitor":{"name":"Julie"}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "competitor": {
    "name": "Julie"
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "competitor": {
    "id": "892399625",
    "name": "Julie",
    "color": 29647,
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "url": "http://company.aha.io/competitors/892399625",
    "resource": "http://company.aha.io/competitors/892399625",
    "custom_fields": [
      {
        "key": "revenue",
        "name": "Revenue",
        "value": "300.0",
        "type": "number"
      }
    ],
    "comments_count": 1
  }
}

DELETE /api/v1/products/:product_id/competitors/:id

Delete competitor

Parameters

Name Description
product_id * Numeric ID, or key of the product to create the competitor in
id * Numeric ID, or key of the competitor to be deleted

DELETE /api/v1/products/PRJ1/competitors/892399625

Example CURL command

curl "https://company.aha.io/api/v1/products/PRJ1/competitors/892399625" -d $'' -X DELETE \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 204 No Content
  

Creative briefs API


POST /api/v1/products/:product_id/creative_briefs

Create a creative brief

Parameters

Name Description
product_id * Numeric ID, or key of the product to create the creative brief in
name * Name of the creative brief
color Hex color of the creative brief in the Aha! UI

POST /api/v1/products/MW1/creative_briefs

Example CURL command

curl "https://company.aha.io/api/v1/products/MW1/creative_briefs" -d $'{"creative_brief":{"name":"April launch"}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "creative_brief": {
    "name": "April launch"
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "creative_brief": {
    "id": "6825596030276674846",
    "name": "April launch",
    "color": 13421772,
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "url": "http://company.aha.io/creative_briefs/6825596030276674846",
    "resource": "http://company.aha.io/creative_briefs/6825596030276674846",
    "custom_fields": [

    ],
    "comments_count": 0
  }
}

GET /api/v1/products/:product_id/creative_briefs

Get all of the creative briefs in a product

Parameters

Name Description
product_id * Numeric ID, or key of the product to retrieve creative briefs for

GET /api/v1/products/MW1/creative_briefs

Example CURL command

curl -g "https://company.aha.io/api/v1/products/MW1/creative_briefs" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "creative_briefs": [
    {
      "id": "476477971",
      "name": "April launch",
      "created_at": "2019-01-01T00:00:00.000Z"
    },
    {
      "id": "982259096",
      "name": "June launch",
      "created_at": "2019-01-01T00:00:00.000Z"
    },
    {
      "id": "91171755",
      "name": "May launch",
      "created_at": "2019-01-01T00:00:00.000Z"
    }
  ],
  "pagination": {
    "total_records": 3,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/creative_briefs/:id

Get a specific creative_brief

Parameters

Name Description
id * Numeric ID of the creative brief to be retrieved

GET /api/v1/creative_briefs/476477971

Example CURL command

curl -g "https://company.aha.io/api/v1/creative_briefs/476477971" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "creative_brief": {
    "id": "476477971",
    "name": "April launch",
    "color": 13421772,
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "url": "http://company.aha.io/creative_briefs/476477971",
    "resource": "http://company.aha.io/creative_briefs/476477971",
    "custom_fields": [

    ],
    "comments_count": 0
  }
}

GET /api/v1/creative_briefs

Search creative briefs by name

Parameters

Name Description
q Sub-string to match against creative brief name

GET /api/v1/creative_briefs?q=April+launch

Example CURL command

curl -g "https://company.aha.io/api/v1/creative_briefs?q=April+launch" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "creative_briefs": [
    {
      "id": "476477971",
      "name": "April launch",
      "created_at": "2019-01-01T00:00:00.000Z"
    }
  ],
  "pagination": {
    "total_records": 1,
    "total_pages": 1,
    "current_page": 1
  }
}

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

Update a creative brief

Parameters

Name Description
product_id * Numeric ID, or key of the product to create the creative brief in
id * Numeric ID, or key of the creative brief to be updated
name Name of the creative brief
color Hex color of the creative brief in the Aha! UI

PUT /api/v1/products/MW1/creative_briefs/476477971

Example CURL command

curl "https://company.aha.io/api/v1/products/MW1/creative_briefs/476477971" -d $'{"creative_brief":{"name":"December launch"}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "creative_brief": {
    "name": "December launch"
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "creative_brief": {
    "id": "476477971",
    "name": "December launch",
    "color": 13421772,
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "url": "http://company.aha.io/creative_briefs/476477971",
    "resource": "http://company.aha.io/creative_briefs/476477971",
    "custom_fields": [

    ],
    "comments_count": 0
  }
}

DELETE /api/v1/products/:product_id/creative_briefs/:id

Delete a creative brief

Parameters

Name Description
product_id * Numeric ID, or key of the product to create the creative brief in
id * Numeric ID, or key of the creative brief to be deleted

DELETE /api/v1/products/MW1/creative_briefs/476477971

Example CURL command

curl "https://company.aha.io/api/v1/products/MW1/creative_briefs/476477971" -d $'' -X DELETE \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 204 No Content
  

Custom Object Links API


Resources that can be linked to records from a Custom Table (called custom objects in the API) can be manipulated in a bulk id-list format. To use Custom Objects Links you must first add a Many-to-Many custom field definition to the resource. When you pass the IDs of custom object records to link to the feature, the existing list of links will be replaced.

Examples of linking custom objects to resources with a Many-to-Many customer field:

Custom Tables are an Enterprise+ exclusive feature.

PUT /api/v1/products/:id

Link custom object records to a product

Custom Tables are an Enterprise+ exclusive feature.

Parameters

Name Description
id * Numeric ID, or key of the product to be edited

PUT /api/v1/products/PRJ1

Example CURL command

curl "https://company.aha.io/api/v1/products/PRJ1" -d $'{"product":{"custom_object_links":{"customers":["640362830"]}}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "product": {
    "custom_object_links": {
      "customers": [
        "640362830"
      ]
    }
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "product": {
    "id": "131414752",
    "reference_prefix": "PRJ1",
    "name": "Project 1",
    "product_line": false,
    "product_line_type": null,
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "description": {
      "id": "21164619",
      "body": "",
      "created_at": "2019-01-01T00:00:00.000Z",
      "attachments": [

      ]
    },
    "url": "http://company.aha.io/projects/PRJ1",
    "resource": "http://company.aha.io/projects/PRJ1",
    "children": [

    ],
    "custom_fields": [

    ],
    "screen_definitions": [
      {
        "id": 405267877,
        "screenable_type": "Ideas::Idea",
        "name": "Screen Definition 5",
        "custom_field_definitions": [
          {
            "id": 711072024,
            "key": "customers_table",
            "position": 1,
            "name": "Customers for custom table",
            "type": "CustomFieldDefinitions::LinkMany",
            "api_type": "array",
            "required": false,
            "options": [
              {
                "id": 1059223798,
                "label": "Globex Corp"
              }
            ]
          }
        ]
      },
      {
        "id": 524951996,
        "screenable_type": "Project",
        "name": "Screen Definition 1",
        "custom_field_definitions": [
          {
            "id": 807801664,
            "key": "name",
            "position": 1,
            "name": "Name",
            "type": "CustomFieldDefinitions::TextField",
            "api_type": "string",
            "required": false,
            "options": [

            ]
          },
          {
            "id": 221120583,
            "key": "website",
            "position": 2,
            "name": "Website",
            "type": "CustomFieldDefinitions::UrlField",
            "api_type": "url",
            "required": false,
            "options": [

            ]
          }
        ]
      },
      {
        "id": 826556567,
        "screenable_type": "Competitor",
        "name": "Screen Definition 3",
        "custom_field_definitions": [

        ]
      },
      {
        "id": 117022249,
        "screenable_type": "StrategicImperative",
        "name": "Screen Definition 13",
        "custom_field_definitions": [

        ]
      },
      {
        "id": 838774462,
        "screenable_type": "Initiative",
        "name": "Screen Definition 12",
        "custom_field_definitions": [
          {
            "id": 250383571,
            "key": "customers",
            "position": 1,
            "name": "Customers",
            "type": "CustomFieldDefinitions::LinkMany",
            "api_type": "array",
            "required": false,
            "options": [
              {
                "id": 640362830,
                "label": "Acme Corp"
              },
              {
                "id": 8397122,
                "label": "Zane Corp"
              }
            ]
          }
        ]
      },
      {
        "id": 647403809,
        "screenable_type": "Release",
        "name": "Screen Definition 8",
        "custom_field_definitions": [
          {
            "id": 3228193,
            "key": "release_custom_date",
            "position": 1,
            "name": "Release custom date",
            "type": "CustomFieldDefinitions::DateField",
            "api_type": "date",
            "required": false,
            "options": [

            ]
          }
        ]
      },
      {
        "id": 908690576,
        "screenable_type": "Epic",
        "name": "Screen Definition 7",
        "custom_field_definitions": [
          {
            "id": 919440521,
            "key": "master_feature_custom_date",
            "position": 1,
            "name": "Master feature custom date",
            "type": "CustomFieldDefinitions::DateField",
            "api_type": "date",
            "required": false,
            "options": [

            ]
          }
        ]
      },
      {
        "id": 19837977,
        "screenable_type": "Feature",
        "name": "Screen Definition 6",
        "custom_field_definitions": [
          {
            "id": 141558949,
            "key": "customers_table",
            "position": 1,
            "name": "Customers for custom table",
            "type": "CustomFieldDefinitions::LinkMany",
            "api_type": "array",
            "required": false,
            "options": [
              {
                "id": 1059223798,
                "label": "Globex Corp"
              }
            ]
          },
          {
            "id": 384804762,
            "key": "product_managers",
            "position": 7,
            "name": "Product Managers",
            "type": "CustomFieldDefinitions::Records::UsersField",
            "api_type": "array",
            "required": false
          }
        ]
      },
      {
        "id": 687341318,
        "screenable_type": "Requirement",
        "name": "Screen Defintion 11",
        "custom_field_definitions": [

        ]
      },
      {
        "id": 790680888,
        "screenable_type": "Ideas::IdeaPortal::New",
        "name": "Screen Definition 4",
        "custom_field_definitions": [

        ]
      }
    ],
    "custom_object_links": [

    ],
    "has_ideas": true,
    "has_master_features": false,
    "release_workflow": {
      "id": 717623509,
      "name": "Default releases workflow",
      "statusable_type": "Release",
      "workflow_type": "release"
    },
    "feature_workflow": {
      "id": 499195972,
      "name": "Default features workflow",
      "statusable_type": "Feature",
      "workflow_type": "feature"
    },
    "requirement_workflow": {
      "id": 499195972,
      "name": "Default features workflow",
      "statusable_type": "Feature",
      "workflow_type": "requirement"
    },
    "idea_workflow": {
      "id": 80245244,
      "name": "Default ideas workflow",
      "statusable_type": "Idea",
      "workflow_type": "idea"
    },
    "strategic_imperative_workflow": {
      "id": 883066232,
      "name": "Default goals workflow",
      "statusable_type": "StrategicImperative",
      "workflow_type": "strategic_imperative"
    },
    "initiative_workflow": {
      "id": 61191651,
      "name": "Default initiatives workflow",
      "statusable_type": "Initiative",
      "workflow_type": "initiative"
    },
    "epic_workflow": {
      "id": 499195972,
      "name": "Default features workflow",
      "statusable_type": "Feature",
      "workflow_type": "epic"
    },
    "capacity_planning_enabled": false,
    "default_capacity_units": 10
  }
}

PUT /api/v1/releases/:id

Link custom object records to a release

Custom Tables are an Enterprise+ exclusive feature.

Parameters

Name Description
id * Numeric ID, or key of the release to be edited

PUT /api/v1/releases/PRJ1-R-1

Example CURL command

curl "https://company.aha.io/api/v1/releases/PRJ1-R-1" -d $'{"release":{"custom_object_links":{"customers":["640362830"]}}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "release": {
    "custom_object_links": {
      "customers": [
        "640362830"
      ]
    }
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "release": {
    "id": "278327321",
    "product_id": 131414752,
    "reference_num": "PRJ1-R-1",
    "name": "Release 1",
    "start_date": "2019-01-01",
    "development_started_on": "2019-01-01",
    "release_date": "2019-01-01",
    "external_release_date": "2019-01-01",
    "external_release_date_description": "May 18, 2020",
    "external_date_resolution": "exact",
    "released": false,
    "parking_lot": false,
    "master_release": false,
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "position": null,
    "progress": null,
    "progress_source": "progress_manual",
    "theme": {
      "id": "522610666",
      "body": "Theme of the release",
      "created_at": "2019-01-01T00:00:00.000Z",
      "attachments": [

      ]
    },
    "url": "http://company.aha.io/releases/PRJ1-R-1",
    "resource": "http://company.aha.io/api/v1/releases/PRJ1-R-1",
    "integration_fields": [
      {
        "id": "68217473",
        "name": "id",
        "value": "777",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2019-01-01T00:00:00.000Z"
      }
    ],
    "custom_fields": [
      {
        "key": "text_field",
        "name": "TextField",
        "value": "Acme Corp",
        "type": "string"
      },
      {
        "key": "note",
        "name": "Note",
        "id": "432637490",
        "body": "<p>sample text</p>",
        "created_at": "2019-01-01T00:00:00.000Z",
        "attachments": [

        ],
        "value": "<p>sample text</p>",
        "type": "note"
      }
    ],
    "custom_object_links": [

    ],
    "comments_count": 1,
    "workflow_status": {
      "id": "738862546",
      "name": "New",
      "position": 1,
      "complete": false,
      "color": "#dce7c6"
    },
    "owner": {
      "id": "16338845",
      "name": "John Smith",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z"
    },
    "goals": [
      {
        "id": "602095703",
        "name": "Goal 1",
        "url": "http://company.aha.io/strategic_imperatives/DEMOENT-G-1",
        "resource": "http://company.aha.io/api/v1/goals/DEMOENT-G-1",
        "created_at": "2019-01-01T00:00:00.000Z",
        "description": {
          "id": "258744266",
          "body": "Description of project1_strategic_imperative1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        }
      }
    ],
    "initiatives": [
      {
        "id": "423077122",
        "name": "Initiative 1",
        "url": "http://company.aha.io/initiatives/PRJ1-S-1",
        "resource": "http://company.aha.io/api/v1/initiatives/PRJ1-S-1",
        "created_at": "2019-01-01T00:00:00.000Z",
        "description": {
          "id": "1007208146",
          "body": "Description of project1_initiative1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        },
        "integration_fields": [
          {
            "id": "365436441",
            "name": "key",
            "value": "JRA-987222",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2019-01-01T00:00:00.000Z"
          },
          {
            "id": "213995437",
            "name": "id",
            "value": "9913333",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2019-01-01T00:00:00.000Z"
          }
        ]
      }
    ],
    "project": {
      "id": "131414752",
      "reference_prefix": "PRJ1",
      "name": "Project 1",
      "product_line": false,
      "created_at": "2019-01-01T00:00:00.000Z"
    },
    "created_by_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z"
    }
  }
}

PUT /api/v1/features/:id

Link custom object records to a feature

Custom Tables are an Enterprise+ exclusive feature.

Parameters

Name Description
id * Numeric ID, or key of the feature to be edited

PUT /api/v1/features/PRJ1-1

Example CURL command

curl "https://company.aha.io/api/v1/features/PRJ1-1" -d $'{"feature":{"custom_object_links":{"customers":["640362830"]}}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "feature": {
    "custom_object_links": {
      "customers": [
        "640362830"
      ]
    }
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "feature": {
    "id": "1007868956",
    "name": "Feature 1",
    "reference_num": "PRJ1-1",
    "position": 1,
    "score": 3,
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "start_date": "2019-01-01",
    "due_date": "2019-01-01",
    "product_id": 131414752,
    "progress": null,
    "progress_source": "progress_manual",
    "workflow_kind": {
      "id": "98484309",
      "name": "New"
    },
    "workflow_status": {
      "id": "934242751",
      "name": "New",
      "position": 1,
      "complete": false,
      "color": "#dce7c6"
    },
    "description": {
      "id": "793547626",
      "body": "Body of note 1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "attachments": [
        {
          "id": "724655692",
          "download_url": "http://company.lvh.me/attachments/724655692/token/a1cc2cad303541d3f986ff11a77282baff072742b3a7b4e370fbd99680d9888e.download?size=original",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "content_type": "text/plain",
          "file_name": "uploaded_file_name.txt",
          "file_size": 123
        }
      ]
    },
    "attachments": [

    ],
    "integration_fields": [
      {
        "id": "728894778",
        "name": "key",
        "value": "JRA-123",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2019-01-01T00:00:00.000Z"
      },
      {
        "id": "846945422",
        "name": "id",
        "value": "435",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2019-01-01T00:00:00.000Z"
      },
      {
        "id": "92040219",
        "name": "url",
        "value": "https://bigaha.atlassian.net/issues/JRA-123",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2019-01-01T00:00:00.000Z"
      }
    ],
    "url": "http://company.aha.io/features/PRJ1-1",
    "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
    "release": {
      "id": "278327321",
      "reference_num": "PRJ1-R-1",
      "name": "Release 1",
      "start_date": "2019-01-01",
      "release_date": "2019-01-01",
      "parking_lot": false,
      "created_at": "2019-01-01T00:00:00.000Z",
      "product_id": 131414752,
      "integration_fields": [
        {
          "id": "68217473",
          "name": "id",
          "value": "777",
          "integration_id": 204584239,
          "service_name": "jira",
          "created_at": "2019-01-01T00:00:00.000Z"
        }
      ],
      "url": "http://company.aha.io/releases/PRJ1-R-1",
      "resource": "http://company.aha.io/api/v1/releases/PRJ1-R-1",
      "owner": {
        "id": "16338845",
        "name": "John Smith",
        "email": "no-reply@aha.io",
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z"
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2019-01-01T00:00:00.000Z"
      }
    },
    "master_feature": {
      "id": "999605892",
      "reference_num": "PRJ1-E-1",
      "name": "Epic 1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/epics/PRJ1-E-1",
      "resource": "http://company.aha.io/api/v1/master_features/PRJ1-E-1"
    },
    "belongs_to_release_phase": {
      "id": "20526005",
      "name": "Alpha",
      "start_on": "2019-01-01",
      "end_on": "2019-01-01",
      "type": "phase",
      "release_id": 278327321,
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "progress": null,
      "progress_source": "progress_manual",
      "description": {
        "id": "243384959",
        "body": "Description of release phase 1",
        "created_at": "2019-01-01T00:00:00.000Z",
        "attachments": [

        ]
      }
    },
    "created_by_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z"
    },
    "assigned_to_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "default_assignee": false
    },
    "requirements": [
      {
        "id": "483368544",
        "name": "Body of requirement 1",
        "reference_num": "PRJ1-1-1",
        "position": 1,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "release_id": 278327321,
        "workflow_status": {
          "id": "934242751",
          "name": "New",
          "position": 1,
          "complete": false,
          "color": "#dce7c6"
        },
        "url": "http://company.aha.io/requirements/PRJ1-1-1",
        "resource": "http://company.aha.io/api/v1/requirements/PRJ1-1-1",
        "description": {
          "id": "910541534",
          "body": "Body of requirement 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": "16338845",
          "name": "John Smith",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "default_assignee": false
        },
        "created_by_user": {
          "id": "1020675218",
          "name": "Mary Humpty",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z"
        },
        "attachments": [

        ],
        "custom_fields": [
          {
            "key": "expected_completion_date",
            "name": "Expected completion date",
            "value": "2019-01-01",
            "type": "date"
          },
          {
            "key": "requested_by",
            "name": "Requested By",
            "value": "TK",
            "type": "string"
          }
        ],
        "integration_fields": [
          {
            "id": "32487847",
            "name": "key",
            "value": "JRA-987",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2019-01-01T00:00:00.000Z"
          },
          {
            "id": "417785887",
            "name": "id",
            "value": "991",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2019-01-01T00:00:00.000Z"
          }
        ],
        "comments_count": 1
      },
      {
        "id": "96915428",
        "name": "Body of requirement 2",
        "reference_num": "PRJ1-1-2",
        "position": 2,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "release_id": 278327321,
        "workflow_status": {
          "id": "1025247908",
          "name": "Shipped",
          "position": 5,
          "complete": true,
          "color": "#ecdd8f"
        },
        "url": "http://company.aha.io/requirements/PRJ1-1-2",
        "resource": "http://company.aha.io/api/v1/requirements/PRJ1-1-2",
        "description": {
          "id": "6825596040217318700",
          "body": "",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": "16338845",
          "name": "John Smith",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "default_assignee": false
        },
        "created_by_user": {
          "id": "1020675218",
          "name": "Mary Humpty",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z"
        },
        "attachments": [

        ],
        "custom_fields": [

        ],
        "integration_fields": [

        ],
        "comments_count": 0
      },
      {
        "id": "851574643",
        "name": "Body of requirement 3",
        "reference_num": "PRJ1-1-3",
        "position": 3,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "release_id": 278327321,
        "workflow_status": {
          "id": "922838743",
          "name": "Not started",
          "position": 8,
          "complete": false,
          "color": "#dce790"
        },
        "url": "http://company.aha.io/requirements/PRJ1-1-3",
        "resource": "http://company.aha.io/api/v1/requirements/PRJ1-1-3",
        "description": {
          "id": "6825596040555777078",
          "body": "",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": "16338845",
          "name": "John Smith",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "default_assignee": false
        },
        "created_by_user": {
          "id": "1020675218",
          "name": "Mary Humpty",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z"
        },
        "attachments": [

        ],
        "custom_fields": [

        ],
        "integration_fields": [

        ],
        "comments_count": 0
      }
    ],
    "initiative": {
      "id": "423077122",
      "name": "Initiative 1",
      "url": "http://company.aha.io/initiatives/PRJ1-S-1",
      "resource": "http://company.aha.io/api/v1/initiatives/PRJ1-S-1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "description": {
        "id": "1007208146",
        "body": "Description of project1_initiative1",
        "created_at": "2019-01-01T00:00:00.000Z",
        "attachments": [

        ]
      },
      "integration_fields": [
        {
          "id": "365436441",
          "name": "key",
          "value": "JRA-987222",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2019-01-01T00:00:00.000Z"
        },
        {
          "id": "213995437",
          "name": "id",
          "value": "9913333",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2019-01-01T00:00:00.000Z"
        }
      ]
    },
    "goals": [
      {
        "id": "602095703",
        "name": "Goal 1",
        "url": "http://company.aha.io/strategic_imperatives/DEMOENT-G-1",
        "resource": "http://company.aha.io/api/v1/goals/DEMOENT-G-1",
        "created_at": "2019-01-01T00:00:00.000Z",
        "description": {
          "id": "258744266",
          "body": "Description of project1_strategic_imperative1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        }
      }
    ],
    "comments_count": 1,
    "score_facts": [
      {
        "id": "728895917",
        "value": 1,
        "name": "Effort"
      },
      {
        "id": "846938137",
        "value": 2,
        "name": "Benefit"
      }
    ],
    "tags": [
      "Engineering",
      "Infrastructure"
    ],
    "full_tags": [
      {
        "id": 3412727,
        "name": "Engineering",
        "color": "#e09052"
      },
      {
        "id": 775582684,
        "name": "Infrastructure",
        "color": "#7552e0"
      }
    ],
    "custom_fields": [
      {
        "key": "expected_completion_date",
        "name": "Expected completion date",
        "value": "2019-01-01",
        "type": "date"
      },
      {
        "key": "equation_specs_field",
        "name": "Equation specs field",
        "value": {
          "values": {
            "123": {
              "value": 10,
              "display_value": "10.0"
            },
            "456": {
              "value": "Foobar",
              "display_value": "Foobar"
            },
            "789": {
              "value": null,
              "display_value": null
            }
          }
        },
        "type": "equation_sheet"
      },
      {
        "key": "negative_scorecard",
        "name": "Negative custom scorecard",
        "value": 31,
        "type": "scorecard",
        "score_facts": [
          {
            "id": "462102328",
            "value": 6,
            "name": "Negative default value"
          }
        ]
      }
    ],
    "custom_object_links": [
      {
        "key": "customers",
        "name": "Customers",
        "record_type": "CustomObjectRecord",
        "record_ids": [
          640362830
        ]
      }
    ],
    "feature_links": [
      {
        "link_type": "Depends on",
        "link_type_id": 20,
        "created_at": "2019-01-01T00:00:00.000Z",
        "parent_record": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "child_record": {
          "id": "622562724",
          "reference_num": "PRJ1-2",
          "name": "Another Feature",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-2",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-2",
          "product_id": 131414752
        }
      }
    ],
    "feature_only_original_estimate": null,
    "feature_only_remaining_estimate": null,
    "feature_only_work_done": null
  }
}

PUT /api/v1/ideas/:id

Link custom object records to an idea

Custom Tables are an Enterprise+ exclusive feature.

Parameters

Name Description
id * Numeric ID, or key of the idea to be edited

PUT /api/v1/ideas/PRJ1-I-1

Example CURL command

curl "https://company.aha.io/api/v1/ideas/PRJ1-I-1" -d $'{"idea":{"custom_object_links":{"customers":["640362830"]}}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "idea": {
    "custom_object_links": {
      "customers": [
        "640362830"
      ]
    }
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "idea": {
    "id": "58056975",
    "name": "Idea 1",
    "reference_num": "PRJ1-I-1",
    "score": 15,
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "product_id": 131414752,
    "votes": 1,
    "workflow_status": {
      "id": "3259216",
      "name": "New",
      "position": 1,
      "complete": false,
      "color": "#dce7c6"
    },
    "description": {
      "id": "103757394",
      "body": "Description of idea 1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "attachments": [

      ]
    },
    "visibility": "Visible to all ideas portal users",
    "url": "http://company.aha.io/ideas/ideas/PRJ1-I-1",
    "resource": "http://company.aha.io/api/v1/ideas/PRJ1-I-1",
    "product": {
      "id": "131414752",
      "reference_prefix": "PRJ1",
      "name": "Project 1",
      "product_line": false,
      "created_at": "2019-01-01T00:00:00.000Z"
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z"
    },
    "assigned_to_user": null,
    "endorsements_count": 1,
    "comments_count": 0,
    "score_facts": [
      {
        "id": "244026645",
        "value": 10,
        "name": "Effort"
      },
      {
        "id": "394452137",
        "value": 5,
        "name": "Benefit"
      }
    ],
    "tags": [
      "Infrastructure"
    ],
    "full_tags": [
      {
        "id": 775582684,
        "name": "Infrastructure",
        "color": "#7552e0"
      }
    ],
    "categories": [
      {
        "id": "972845454",
        "name": "Hard disk drive",
        "parent_id": 552935478,
        "created_at": "2019-01-01T00:00:00.000Z"
      }
    ],
    "custom_fields": [
      {
        "key": "component",
        "name": "Component",
        "value": "web",
        "type": "array"
      },
      {
        "key": "custom_scorecard_definition",
        "name": "Some custom scorecard definition",
        "value": 11,
        "type": "scorecard",
        "score_facts": [
          {
            "id": "84642379",
            "value": 10,
            "name": "Effort"
          }
        ]
      },
      {
        "key": "text_field1",
        "name": "TextField1",
        "value": "Cairo",
        "type": "string"
      },
      {
        "key": "text_field2",
        "name": "TextField2",
        "value": "Rennes",
        "type": "string"
      }
    ],
    "custom_object_links": [
      {
        "key": "customers_table",
        "name": "Customers for custom table",
        "record_type": "CustomObjectRecord",
        "record_ids": [

        ]
      }
    ]
  }
}

PUT /api/v1/initiatives/:id

Link custom object records to an initiative

Custom Tables are an Enterprise+ exclusive feature.

Parameters

Name Description
id * Numeric ID, or key of the initiative to be edited

PUT /api/v1/initiatives/423077122

Example CURL command

curl "https://company.aha.io/api/v1/initiatives/423077122" -d $'{"initiative":{"custom_object_links":{"customers":["640362830"]}}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "initiative": {
    "custom_object_links": {
      "customers": [
        "640362830"
      ]
    }
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "initiative": {
    "id": "423077122",
    "name": "Initiative 1",
    "reference_num": "PRJ1-S-1",
    "status": "not_started",
    "effort": 10,
    "value": 70,
    "presented": true,
    "start_date": null,
    "end_date": null,
    "position": 1,
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "product_id": 131414752,
    "progress": null,
    "progress_source": "progress_manual",
    "url": "http://company.aha.io/initiatives/PRJ1-S-1",
    "resource": "http://company.aha.io/api/v1/initiatives/PRJ1-S-1",
    "project": {
      "id": "131414752",
      "reference_prefix": "PRJ1",
      "name": "Project 1",
      "product_line": false,
      "created_at": "2019-01-01T00:00:00.000Z"
    },
    "workflow_status": {
      "id": "53968949",
      "name": "Not Started",
      "position": 1,
      "complete": false,
      "color": "#dce7c6"
    },
    "description": {
      "id": "1007208146",
      "body": "Description of project1_initiative1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "attachments": [

      ]
    },
    "attachments": [

    ],
    "assigned_to_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "default_assignee": false
    },
    "comments_count": 1,
    "goals": [
      {
        "id": "602095703",
        "name": "Goal 1",
        "url": "http://company.aha.io/strategic_imperatives/DEMOENT-G-1",
        "resource": "http://company.aha.io/api/v1/goals/DEMOENT-G-1",
        "created_at": "2019-01-01T00:00:00.000Z",
        "description": {
          "id": "258744266",
          "body": "Description of project1_strategic_imperative1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        }
      }
    ],
    "features": [
      {
        "id": "1007868956",
        "reference_num": "PRJ1-1",
        "name": "Feature 1",
        "created_at": "2019-01-01T00:00:00.000Z",
        "url": "http://company.aha.io/features/PRJ1-1",
        "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
        "product_id": 131414752
      }
    ],
    "master_features": [
      {
        "id": "580753216",
        "reference_num": "PRJ1-E-2",
        "name": "Here's another epic",
        "created_at": "2019-01-01T00:00:00.000Z",
        "url": "http://company.aha.io/epics/PRJ1-E-2",
        "resource": "http://company.aha.io/api/v1/master_features/PRJ1-E-2"
      },
      {
        "id": "362457003",
        "reference_num": "PRJ1-E-3",
        "name": "And a third",
        "created_at": "2019-01-01T00:00:00.000Z",
        "url": "http://company.aha.io/epics/PRJ1-E-3",
        "resource": "http://company.aha.io/api/v1/master_features/PRJ1-E-3"
      },
      {
        "id": "999605892",
        "reference_num": "PRJ1-E-1",
        "name": "Epic 1",
        "created_at": "2019-01-01T00:00:00.000Z",
        "url": "http://company.aha.io/epics/PRJ1-E-1",
        "resource": "http://company.aha.io/api/v1/master_features/PRJ1-E-1"
      }
    ],
    "releases": [
      {
        "id": "278327321",
        "reference_num": "PRJ1-R-1",
        "name": "Release 1",
        "start_date": "2019-01-01",
        "release_date": "2019-01-01",
        "parking_lot": false,
        "created_at": "2019-01-01T00:00:00.000Z",
        "product_id": 131414752,
        "integration_fields": [
          {
            "id": "68217473",
            "name": "id",
            "value": "777",
            "integration_id": 204584239,
            "service_name": "jira",
            "created_at": "2019-01-01T00:00:00.000Z"
          }
        ],
        "url": "http://company.aha.io/releases/PRJ1-R-1",
        "resource": "http://company.aha.io/api/v1/releases/PRJ1-R-1",
        "owner": {
          "id": "16338845",
          "name": "John Smith",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z"
        },
        "project": {
          "id": "131414752",
          "reference_prefix": "PRJ1",
          "name": "Project 1",
          "product_line": false,
          "created_at": "2019-01-01T00:00:00.000Z"
        }
      },
      {
        "id": "161456549",
        "reference_num": "PRJ1-R-2",
        "name": "Release 2",
        "start_date": "2019-01-01",
        "release_date": "2019-01-01",
        "parking_lot": false,
        "created_at": "2019-01-01T00:00:00.000Z",
        "product_id": 131414752,
        "integration_fields": [

        ],
        "url": "http://company.aha.io/releases/PRJ1-R-2",
        "resource": "http://company.aha.io/api/v1/releases/PRJ1-R-2",
        "owner": {
          "id": "16338845",
          "name": "John Smith",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z"
        },
        "project": {
          "id": "131414752",
          "reference_prefix": "PRJ1",
          "name": "Project 1",
          "product_line": false,
          "created_at": "2019-01-01T00:00:00.000Z"
        }
      }
    ],
    "integration_fields": [
      {
        "id": "365436441",
        "name": "key",
        "value": "JRA-987222",
        "integration_id": 342659513,
        "service_name": "jira",
        "created_at": "2019-01-01T00:00:00.000Z"
      },
      {
        "id": "213995437",
        "name": "id",
        "value": "9913333",
        "integration_id": 342659513,
        "service_name": "jira",
        "created_at": "2019-01-01T00:00:00.000Z"
      }
    ],
    "custom_fields": [

    ],
    "custom_object_links": [
      {
        "key": "customers",
        "name": "Customers",
        "record_type": "CustomObjectRecord",
        "record_ids": [
          640362830
        ]
      }
    ]
  }
}

PUT /api/v1/goals/:id

Link custom object records to a goal

Custom Tables are an Enterprise+ exclusive feature.

Parameters

Name Description
id * Numeric ID, or key of the goal to be edited

PUT /api/v1/goals/602095703

Example CURL command

curl "https://company.aha.io/api/v1/goals/602095703" -d $'{"goal":{"custom_object_links":{"customers":["640362830"]}}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "goal": {
    "custom_object_links": {
      "customers": [
        "640362830"
      ]
    }
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "goal": {
    "id": "602095703",
    "name": "Goal 1",
    "effort": 10,
    "value": 70,
    "position": 1,
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "product_id": 131414752,
    "progress": null,
    "progress_source": "progress_manual",
    "url": "http://company.aha.io/strategic_imperatives/DEMOENT-G-1",
    "resource": "http://company.aha.io/strategic_imperatives/DEMOENT-G-1",
    "description": {
      "id": "258744266",
      "body": "Description of project1_strategic_imperative1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "attachments": [

      ]
    },
    "success_metric": {
      "name": "Metric 1",
      "description": {
        "id": "132688270",
        "body": "Description of project1_strategic_imperative1_strategic_imperative_metric",
        "created_at": "2019-01-01T00:00:00.000Z",
        "attachments": [

        ]
      },
      "workflow_status": {
        "id": "396368932",
        "name": "On Track",
        "position": 2,
        "complete": false,
        "color": "#ecdd8f"
      }
    },
    "project": {
      "id": "131414752",
      "reference_prefix": "PRJ1",
      "name": "Project 1",
      "product_line": false,
      "created_at": "2019-01-01T00:00:00.000Z"
    },
    "initiatives": [
      {
        "id": "423077122",
        "name": "Initiative 1",
        "url": "http://company.aha.io/initiatives/PRJ1-S-1",
        "resource": "http://company.aha.io/api/v1/initiatives/PRJ1-S-1",
        "created_at": "2019-01-01T00:00:00.000Z",
        "description": {
          "id": "1007208146",
          "body": "Description of project1_initiative1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        },
        "integration_fields": [
          {
            "id": "365436441",
            "name": "key",
            "value": "JRA-987222",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2019-01-01T00:00:00.000Z"
          },
          {
            "id": "213995437",
            "name": "id",
            "value": "9913333",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2019-01-01T00:00:00.000Z"
          }
        ]
      }
    ],
    "comments_count": 1,
    "features": [
      {
        "id": "1007868956",
        "reference_num": "PRJ1-1",
        "name": "Feature 1",
        "created_at": "2019-01-01T00:00:00.000Z",
        "url": "http://company.aha.io/features/PRJ1-1",
        "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
        "product_id": 131414752
      }
    ],
    "releases": [
      {
        "id": "278327321",
        "reference_num": "PRJ1-R-1",
        "name": "Release 1",
        "start_date": "2019-01-01",
        "release_date": "2019-01-01",
        "parking_lot": false,
        "created_at": "2019-01-01T00:00:00.000Z",
        "product_id": 131414752,
        "integration_fields": [
          {
            "id": "68217473",
            "name": "id",
            "value": "777",
            "integration_id": 204584239,
            "service_name": "jira",
            "created_at": "2019-01-01T00:00:00.000Z"
          }
        ],
        "url": "http://company.aha.io/releases/PRJ1-R-1",
        "resource": "http://company.aha.io/api/v1/releases/PRJ1-R-1",
        "owner": {
          "id": "16338845",
          "name": "John Smith",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z"
        },
        "project": {
          "id": "131414752",
          "reference_prefix": "PRJ1",
          "name": "Project 1",
          "product_line": false,
          "created_at": "2019-01-01T00:00:00.000Z"
        }
      }
    ],
    "custom_fields": [

    ],
    "custom_object_links": [

    ]
  }
}

PUT /api/v1/custom_object_records/:id

Link custom table records to another custom table record

Custom Tables are an Enterprise+ exclusive feature.

Parameters

Name Description
id * Numeric ID of the custom object record to be updated

PUT /api/v1/custom_object_records/640362830

Example CURL command

curl "https://company.aha.io/api/v1/custom_object_records/640362830" -d $'{"custom_object_record":{"custom_object_links":{"custom_table_name_submitters":[136661093]}}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "custom_object_record": {
    "custom_object_links": {
      "custom_table_name_submitters": [
        136661093
      ]
    }
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "custom_object_record": {
    "id": "640362830",
    "product_id": 131414752,
    "key": "customers",
    "custom_fields": [
      {
        "key": "name",
        "name": "Name",
        "value": "Acme Corp",
        "type": "string"
      },
      {
        "key": "website",
        "name": "Website",
        "value": "www.acme.com",
        "type": "url"
      }
    ],
    "custom_object_links": [
      {
        "key": "custom_table_name_link_many",
        "name": "Custom Table Linked Records",
        "record_type": "CustomObjectRecord",
        "record_ids": [
          1059223798
        ]
      },
      {
        "key": "custom_table_name_submitters",
        "name": "Custom Table Linked Submitters",
        "record_type": "CustomObjectRecord",
        "record_ids": [
          136661093
        ]
      },
      {
        "key": "custom_table_name_link_master_detail",
        "name": "Custom Table Master Detail Field",
        "record_type": "CustomObjectRecord",
        "record_ids": [

        ]
      }
    ],
    "linked_records": [
      {
        "key": "revenue",
        "name": "Revenue",
        "record_type": "Ideas::Idea",
        "record_id": 58056975
      },
      {
        "key": "submitters",
        "name": "Submitters",
        "record_type": "Ideas::Idea",
        "record_id": 58056975
      },
      {
        "key": "customers",
        "name": "Customers",
        "record_type": "Ideas::Idea",
        "record_id": 162120796
      }
    ]
  }
}

Custom Object Records API


Custom Tables have a different set of custom objects for each Product. This means that if you want to create one or list them you must scope them to a product.

Once you have the id of a specific custom object record, you can inspect, modify, or delete them on the root custom objects resource.

Custom Tables are an Enterprise+ exclusive feature.

POST /api/v1/products/:product_id/custom_objects/:key/records

Create a custom object record

Parameters

Name Description
product_id * Numeric ID, or key of the product to create the record in
key * API key of the custom object type to create

POST /api/v1/products/PRJ1/custom_objects/customers/records

Example CURL command

curl "https://company.aha.io/api/v1/products/PRJ1/custom_objects/customers/records" -d $'{"custom_object_record":{"custom_fields":{"name":"Major conglomerate","website":"www.conglom.com"}}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "custom_object_record": {
    "custom_fields": {
      "name": "Major conglomerate",
      "website": "www.conglom.com"
    }
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "custom_object_record": {
    "id": "6825596047708319312",
    "product_id": 131414752,
    "key": "customers",
    "custom_fields": [
      {
        "key": "website",
        "name": "Website",
        "value": "www.conglom.com",
        "type": "url"
      },
      {
        "key": "name",
        "name": "Name",
        "value": "Major conglomerate",
        "type": "string"
      }
    ],
    "custom_object_links": [
      {
        "key": "custom_table_name_link_many",
        "name": "Custom Table Linked Records",
        "record_type": "CustomObjectRecord",
        "record_ids": [

        ]
      },
      {
        "key": "custom_table_name_submitters",
        "name": "Custom Table Linked Submitters",
        "record_type": "CustomObjectRecord",
        "record_ids": [

        ]
      },
      {
        "key": "custom_table_name_link_master_detail",
        "name": "Custom Table Master Detail Field",
        "record_type": "CustomObjectRecord",
        "record_ids": [

        ]
      }
    ],
    "linked_records": [

    ]
  }
}

GET /api/v1/products/:product_id/custom_objects/:key/records

Get all objects from a custom table

Custom Tables are an Enterprise+ exclusive feature.

Parameters

Name Description
product_id * Numeric ID, or key of the product to get page for
key * API key of the custom object to get records for

GET /api/v1/products/PRJ1/custom_objects/customers/records

Example CURL command

curl -g "https://company.aha.io/api/v1/products/PRJ1/custom_objects/customers/records" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "custom_object_records": [
    {
      "id": "8397122",
      "product_id": 131414752,
      "key": "customers",
      "custom_fields": [
        {
          "key": "name",
          "name": "Name",
          "value": "Zane Corp",
          "type": "string"
        }
      ],
      "custom_object_links": [
        {
          "key": "custom_table_name_link_many",
          "name": "Custom Table Linked Records",
          "record_type": "CustomObjectRecord",
          "record_ids": [

          ]
        },
        {
          "key": "custom_table_name_submitters",
          "name": "Custom Table Linked Submitters",
          "record_type": "CustomObjectRecord",
          "record_ids": [

          ]
        },
        {
          "key": "custom_table_name_link_master_detail",
          "name": "Custom Table Master Detail Field",
          "record_type": "CustomObjectRecord",
          "record_ids": [

          ]
        }
      ],
      "linked_records": [

      ]
    },
    {
      "id": "640362830",
      "product_id": 131414752,
      "key": "customers",
      "custom_fields": [
        {
          "key": "name",
          "name": "Name",
          "value": "Acme Corp",
          "type": "string"
        },
        {
          "key": "website",
          "name": "Website",
          "value": "www.acme.com",
          "type": "url"
        }
      ],
      "custom_object_links": [
        {
          "key": "custom_table_name_link_many",
          "name": "Custom Table Linked Records",
          "record_type": "CustomObjectRecord",
          "record_ids": [
            1059223798
          ]
        },
        {
          "key": "custom_table_name_submitters",
          "name": "Custom Table Linked Submitters",
          "record_type": "CustomObjectRecord",
          "record_ids": [

          ]
        },
        {
          "key": "custom_table_name_link_master_detail",
          "name": "Custom Table Master Detail Field",
          "record_type": "CustomObjectRecord",
          "record_ids": [

          ]
        }
      ],
      "linked_records": [
        {
          "key": "revenue",
          "name": "Revenue",
          "record_type": "Ideas::Idea",
          "record_id": 58056975
        },
        {
          "key": "submitters",
          "name": "Submitters",
          "record_type": "Ideas::Idea",
          "record_id": 58056975
        },
        {
          "key": "customers",
          "name": "Customers",
          "record_type": "Ideas::Idea",
          "record_id": 162120796
        }
      ]
    }
  ],
  "pagination": {
    "total_records": 2,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/custom_object_records/:id

Get a specific custom object record

Custom Tables are an Enterprise+ exclusive feature.

Parameters

Name Description
id * Numeric ID of the custom object record to be retrieved

GET /api/v1/custom_object_records/640362830

Example CURL command

curl -g "https://company.aha.io/api/v1/custom_object_records/640362830" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "custom_object_record": {
    "id": "640362830",
    "product_id": 131414752,
    "key": "customers",
    "custom_fields": [
      {
        "key": "name",
        "name": "Name",
        "value": "Acme Corp",
        "type": "string"
      },
      {
        "key": "website",
        "name": "Website",
        "value": "www.acme.com",
        "type": "url"
      }
    ],
    "custom_object_links": [
      {
        "key": "custom_table_name_link_many",
        "name": "Custom Table Linked Records",
        "record_type": "CustomObjectRecord",
        "record_ids": [
          1059223798
        ]
      },
      {
        "key": "custom_table_name_submitters",
        "name": "Custom Table Linked Submitters",
        "record_type": "CustomObjectRecord",
        "record_ids": [

        ]
      },
      {
        "key": "custom_table_name_link_master_detail",
        "name": "Custom Table Master Detail Field",
        "record_type": "CustomObjectRecord",
        "record_ids": [

        ]
      }
    ],
    "linked_records": [
      {
        "key": "revenue",
        "name": "Revenue",
        "record_type": "Ideas::Idea",
        "record_id": 58056975
      },
      {
        "key": "submitters",
        "name": "Submitters",
        "record_type": "Ideas::Idea",
        "record_id": 58056975
      },
      {
        "key": "customers",
        "name": "Customers",
        "record_type": "Ideas::Idea",
        "record_id": 162120796
      }
    ]
  }
}

PUT /api/v1/custom_object_records/:id

Update a custom object record

Parameters

Name Description
id * Numeric ID of the custom object record to be updated

PUT /api/v1/custom_object_records/640362830

Example CURL command

curl "https://company.aha.io/api/v1/custom_object_records/640362830" -d $'{"custom_object_record":{"custom_fields":{"name":"Acme parent corp","website":"www.acmeparent.com"}}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "custom_object_record": {
    "custom_fields": {
      "name": "Acme parent corp",
      "website": "www.acmeparent.com"
    }
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "custom_object_record": {
    "id": "640362830",
    "product_id": 131414752,
    "key": "customers",
    "custom_fields": [
      {
        "key": "name",
        "name": "Name",
        "value": "Acme parent corp",
        "type": "string"
      },
      {
        "key": "website",
        "name": "Website",
        "value": "www.acmeparent.com",
        "type": "url"
      }
    ],
    "custom_object_links": [
      {
        "key": "custom_table_name_link_many",
        "name": "Custom Table Linked Records",
        "record_type": "CustomObjectRecord",
        "record_ids": [
          1059223798
        ]
      },
      {
        "key": "custom_table_name_submitters",
        "name": "Custom Table Linked Submitters",
        "record_type": "CustomObjectRecord",
        "record_ids": [

        ]
      },
      {
        "key": "custom_table_name_link_master_detail",
        "name": "Custom Table Master Detail Field",
        "record_type": "CustomObjectRecord",
        "record_ids": [

        ]
      }
    ],
    "linked_records": [
      {
        "key": "revenue",
        "name": "Revenue",
        "record_type": "Ideas::Idea",
        "record_id": 58056975
      },
      {
        "key": "submitters",
        "name": "Submitters",
        "record_type": "Ideas::Idea",
        "record_id": 58056975
      },
      {
        "key": "customers",
        "name": "Customers",
        "record_type": "Ideas::Idea",
        "record_id": 162120796
      }
    ]
  }
}

DELETE /api/v1/custom_object_records/:id

Delete a custom object record

Custom Tables are an Enterprise+ exclusive feature.

Parameters

Name Description
id * Numeric ID of the custom object record to be deleted

DELETE /api/v1/custom_object_records/640362830

Example CURL command

curl "https://company.aha.io/api/v1/custom_object_records/640362830" -d $'' -X DELETE \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 204 No Content
  

Custom Pivot API


The custom pivots API allows you to take existing list and pivot reports and represent them as JSON. This enables developers to pull related data from multiple types of records in a single API query.

There are two types of reports that you can pull via this API: list or pivot. See the documentation below for a full explanation of their formats.

The :report_id parameter is the ID of a saved view in Aha!. To find the ID of an existing report, choose the report from the Views -> Saved views dropdown in Aha!. Then take the large number of the end of the URL that looks like: /bookmarks/custom_pivots/6434552458299516367. In this case the :report_id is 6434552458299516367.

GET /api/v1/bookmarks/custom_pivots/:report_id

List view

The list view responds with a JSON object with three attributes: pagination, columns, and rows.

The columns attribute is an array of objects that give detailed information about the columns of the list. The objects include the name of the table, the field, and a human readable title attribute.

The rows attribute is an of array of arrays. Each object within the inner array contains the value of that for a specific column. Each object contains attributes for various representations of the data. The fields are:

  • id: The unique id of the object
  • plain_value: A string representation of the object
  • html_value: An HTML representation of the object. This is the same HTML that is used in Aha! to represent the value in our reports.
  • rich_value: If the object is a reference to another object (such as a tag), the, this will be the object representation. For instance, a tag would be representated as: { id: "6013053275679792248", name: "API" }

The third attribute is pagination. This works like everywhere else in the Aha! API and is documented here.

Parameters

Name Description
report_id The ID of the saved view in Aha! to return data for.
view The type of API response you want. This should either be list or pivot. It defaults to list

GET /api/v1/bookmarks/custom_pivots/801750833?view=list

Example CURL command

curl -g "https://company.aha.io/api/v1/bookmarks/custom_pivots/801750833?view=list" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "pagination": [
    {
      "total_records": 5,
      "total_pages": 1,
      "current_page": 1
    }
  ],
  "columns": [
    {
      "table": "projects",
      "field": "name",
      "title": "Workspace name"
    },
    {
      "table": "releases",
      "field": "name",
      "title": "Release name"
    },
    {
      "table": "features",
      "field": "name",
      "title": "Feature name"
    },
    {
      "table": "features",
      "field": "reference_num",
      "title": "Feature reference #"
    },
    {
      "table": "features",
      "field": "status",
      "title": "Feature status"
    },
    {
      "table": "ideas",
      "field": "created_by_user_id",
      "title": "Idea created by"
    }
  ],
  "rows": [
    [
      {
        "id": 131414752,
        "plain_value": "Project 1",
        "html_value": "<a data-drawer-url=\"/projects/PRJ1\" href=\"/projects/PRJ1\">Project 1</a>",
        "rich_value": "Project 1"
      },
      {
        "id": 278327321,
        "plain_value": "Release 1",
        "html_value": "<a data-drawer-url=\"/releases/PRJ1-R-1\" href=\"/releases/PRJ1-R-1\">Release 1</a>",
        "rich_value": "Release 1"
      },
      {
        "id": 209201304,
        "plain_value": "Another Fourth Feature",
        "html_value": "<a data-drawer-url=\"/features/PRJ1-4\" href=\"/features/PRJ1-4\">Another Fourth Feature</a>",
        "rich_value": "Another Fourth Feature"
      },
      {
        "id": 209201304,
        "plain_value": "PRJ1-4",
        "html_value": "<a data-drawer-url=\"/features/PRJ1-4\" href=\"/features/PRJ1-4\">PRJ1-4</a>",
        "rich_value": "PRJ1-4"
      },
      {
        "id": 209201304,
        "plain_value": "Designed",
        "html_value": "<span class=\"status-pill\" style=\"border-color: #ecdd8f; background-color: #F7F1D2; color: #5E5839;\">Designed</span>",
        "rich_value": {
          "id": 962984386,
          "name": "Designed",
          "color": "727272"
        }
      },
      {
        "id": null,
        "plain_value": null,
        "html_value": null,
        "rich_value": null
      }
    ],
    [
      {
        "id": 131414752,
        "plain_value": "Project 1",
        "html_value": "<a data-drawer-url=\"/projects/PRJ1\" href=\"/projects/PRJ1\">Project 1</a>",
        "rich_value": "Project 1"
      },
      {
        "id": 278327321,
        "plain_value": "Release 1",
        "html_value": "<a data-drawer-url=\"/releases/PRJ1-R-1\" href=\"/releases/PRJ1-R-1\">Release 1</a>",
        "rich_value": "Release 1"
      },
      {
        "id": 303873333,
        "plain_value": "Another Third Feature",
        "html_value": "<a data-drawer-url=\"/features/PRJ1-3\" href=\"/features/PRJ1-3\">Another Third Feature</a>",
        "rich_value": "Another Third Feature"
      },
      {
        "id": 303873333,
        "plain_value": "PRJ1-3",
        "html_value": "<a data-drawer-url=\"/features/PRJ1-3\" href=\"/features/PRJ1-3\">PRJ1-3</a>",
        "rich_value": "PRJ1-3"
      },
      {
        "id": 303873333,
        "plain_value": "Designed",
        "html_value": "<span class=\"status-pill\" style=\"border-color: #ecdd8f; background-color: #F7F1D2; color: #5E5839;\">Designed</span>",
        "rich_value": {
          "id": 962984386,
          "name": "Designed",
          "color": "727272"
        }
      },
      {
        "id": null,
        "plain_value": null,
        "html_value": null,
        "rich_value": null
      }
    ],
    [
      {
        "id": 131414752,
        "plain_value": "Project 1",
        "html_value": "<a data-drawer-url=\"/projects/PRJ1\" href=\"/projects/PRJ1\">Project 1</a>",
        "rich_value": "Project 1"
      },
      {
        "id": 278327321,
        "plain_value": "Release 1",
        "html_value": "<a data-drawer-url=\"/releases/PRJ1-R-1\" href=\"/releases/PRJ1-R-1\">Release 1</a>",
        "rich_value": "Release 1"
      },
      {
        "id": 622562724,
        "plain_value": "Another Feature",
        "html_value": "<a data-drawer-url=\"/features/PRJ1-2\" href=\"/features/PRJ1-2\">Another Feature</a>",
        "rich_value": "Another Feature"
      },
      {
        "id": 622562724,
        "plain_value": "PRJ1-2",
        "html_value": "<a data-drawer-url=\"/features/PRJ1-2\" href=\"/features/PRJ1-2\">PRJ1-2</a>",
        "rich_value": "PRJ1-2"
      },
      {
        "id": 622562724,
        "plain_value": "Designed",
        "html_value": "<span class=\"status-pill\" style=\"border-color: #ecdd8f; background-color: #F7F1D2; color: #5E5839;\">Designed</span>",
        "rich_value": {
          "id": 962984386,
          "name": "Designed",
          "color": "727272"
        }
      },
      {
        "id": null,
        "plain_value": null,
        "html_value": null,
        "rich_value": null
      }
    ],
    [
      {
        "id": 131414752,
        "plain_value": "Project 1",
        "html_value": "<a data-drawer-url=\"/projects/PRJ1\" href=\"/projects/PRJ1\">Project 1</a>",
        "rich_value": "Project 1"
      },
      {
        "id": 278327321,
        "plain_value": "Release 1",
        "html_value": "<a data-drawer-url=\"/releases/PRJ1-R-1\" href=\"/releases/PRJ1-R-1\">Release 1</a>",
        "rich_value": "Release 1"
      },
      {
        "id": 1007868956,
        "plain_value": "Feature 1",
        "html_value": "<a data-drawer-url=\"/features/PRJ1-1\" href=\"/features/PRJ1-1\">Feature 1</a>",
        "rich_value": "Feature 1"
      },
      {
        "id": 1007868956,
        "plain_value": "PRJ1-1",
        "html_value": "<a data-drawer-url=\"/features/PRJ1-1\" href=\"/features/PRJ1-1\">PRJ1-1</a>",
        "rich_value": "PRJ1-1"
      },
      {
        "id": 1007868956,
        "plain_value": "New",
        "html_value": "<span class=\"status-pill\" style=\"border-color: #dce7c6; background-color: #F1F5E8; color: #585C4F;\">New</span>",
        "rich_value": {
          "id": 934242751,
          "name": "New",
          "color": "727272"
        }
      },
      {
        "id": 444379319,
        "plain_value": "John Long (john@long.com)",
        "html_value": "John Long (john@long.com)",
        "rich_value": {
          "id": 646391926,
          "name": "John Long (john@long.com)"
        }
      }
    ],
    [
      {
        "id": 131414752,
        "plain_value": "Project 1",
        "html_value": "<a data-drawer-url=\"/projects/PRJ1\" href=\"/projects/PRJ1\">Project 1</a>",
        "rich_value": "Project 1"
      },
      {
        "id": 278327321,
        "plain_value": "Release 1",
        "html_value": "<a data-drawer-url=\"/releases/PRJ1-R-1\" href=\"/releases/PRJ1-R-1\">Release 1</a>",
        "rich_value": "Release 1"
      },
      {
        "id": 1007868956,
        "plain_value": "Feature 1",
        "html_value": "<a data-drawer-url=\"/features/PRJ1-1\" href=\"/features/PRJ1-1\">Feature 1</a>",
        "rich_value": "Feature 1"
      },
      {
        "id": 1007868956,
        "plain_value": "PRJ1-1",
        "html_value": "<a data-drawer-url=\"/features/PRJ1-1\" href=\"/features/PRJ1-1\">PRJ1-1</a>",
        "rich_value": "PRJ1-1"
      },
      {
        "id": 1007868956,
        "plain_value": "New",
        "html_value": "<span class=\"status-pill\" style=\"border-color: #dce7c6; background-color: #F1F5E8; color: #585C4F;\">New</span>",
        "rich_value": {
          "id": 934242751,
          "name": "New",
          "color": "727272"
        }
      },
      {
        "id": 1055237874,
        "plain_value": "John Long (john@long.com)",
        "html_value": "John Long (john@long.com)",
        "rich_value": {
          "id": 646391926,
          "name": "John Long (john@long.com)"
        }
      }
    ]
  ]
}

GET /api/v1/bookmarks/custom_pivots/:report_id

Pivot view

The pivot view is similar to the list view, but is more referential. There are six attributes in the JSON response: top_level_columns, columns, top_level_rows, rows, cells, field_definitions.

The columns attribute is an object where the keys are the unique id of column within the report. Rows and field_definitions have the same referential treamtment. The attributes are the id in order to ease lookup.

Since pivot reports are referential in nature and can be nested, there are top_level_rows and top_level_columns. This allows you to easily iterate throught the nested structure. Each column and row object contain a reference to their parent object (parent_ref). They also contain a set of references to their direct children (child_refs). They also, along with cells, contain a reference to their field definition (via field_definitions_refs).

The field definitions object is an object that acts as a map to look up the definitions of the fields used within the report. Similarly to the list view, these contain table, field, and title attributes.

The cells attribute is a set of nested arrays. The lowest level array is a list of the fields for a specific value. Each element in this set has a row_ref, column_ref, and field_definition_ref which can be used to lookup which column and row this value is representing. Just like the list view, there are multiple formats of the value:

  • id: The unique id of the object
  • plain_value: A string representation of the object
  • html_value: An HTML representation of the object. This is the same HTML that is used in Aha! to represent the value in our reports.
  • rich_value: If the object is a reference to another object (such as a tag), the, this will be the object representation.

There is no pagination with pivot report.

Parameters

Name Description
report_id The ID of the saved view in Aha! to return data for.
view The type of API response you want. This should either be list or pivot. It defaults to list

GET /api/v1/bookmarks/custom_pivots/801750833?view=pivot

Example CURL command

curl -g "https://company.aha.io/api/v1/bookmarks/custom_pivots/801750833?view=pivot" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "top_level_columns": [
    1
  ],
  "columns": {
    "1": {
      "ref": 1,
      "parent_ref": null,
      "child_refs": [

      ],
      "id": 131414752,
      "plain_value": "Project 1",
      "html_value": "<a data-drawer-url=\"/projects/PRJ1\" href=\"/projects/PRJ1\">Project 1</a>",
      "rich_value": "Project 1",
      "field_definition_ref": 3
    }
  },
  "top_level_rows": [
    2
  ],
  "rows": {
    "2": {
      "ref": 2,
      "parent_ref": null,
      "child_refs": [

      ],
      "id": 278327321,
      "plain_value": "Release 1",
      "html_value": "<a data-drawer-url=\"/releases/PRJ1-R-1\" href=\"/releases/PRJ1-R-1\">Release 1</a>",
      "rich_value": "Release 1",
      "field_definition_ref": 4
    }
  },
  "cells": [
    [
      [
        [
          {
            "id": 1007868956,
            "plain_value": "PRJ1-1",
            "html_value": "<a data-drawer-url=\"/features/PRJ1-1\" href=\"/features/PRJ1-1\">PRJ1-1</a>",
            "rich_value": "PRJ1-1",
            "row_ref": 2,
            "column_ref": 1,
            "field_definition_ref": 5
          },
          {
            "id": 1007868956,
            "plain_value": "Feature 1",
            "html_value": "<a data-drawer-url=\"/features/PRJ1-1\" href=\"/features/PRJ1-1\">Feature 1</a>",
            "rich_value": "Feature 1",
            "row_ref": 2,
            "column_ref": 1,
            "field_definition_ref": 6
          },
          {
            "id": 1007868956,
            "plain_value": "New",
            "html_value": "<span class=\"status-pill\" style=\"border-color: #dce7c6; background-color: #F1F5E8; color: #585C4F;\">New</span>",
            "rich_value": {
              "id": 934242751,
              "name": "New",
              "color": "727272"
            },
            "row_ref": 2,
            "column_ref": 1,
            "field_definition_ref": 7
          },
          {
            "id": 1055237874,
            "plain_value": "John Long (john@long.com)",
            "html_value": "John Long (john@long.com)",
            "rich_value": {
              "id": 646391926,
              "name": "John Long (john@long.com)"
            },
            "row_ref": 2,
            "column_ref": 1,
            "field_definition_ref": 8
          }
        ],
        [
          {
            "id": 622562724,
            "plain_value": "PRJ1-2",
            "html_value": "<a data-drawer-url=\"/features/PRJ1-2\" href=\"/features/PRJ1-2\">PRJ1-2</a>",
            "rich_value": "PRJ1-2",
            "row_ref": 2,
            "column_ref": 1,
            "field_definition_ref": 5
          },
          {
            "id": 622562724,
            "plain_value": "Another Feature",
            "html_value": "<a data-drawer-url=\"/features/PRJ1-2\" href=\"/features/PRJ1-2\">Another Feature</a>",
            "rich_value": "Another Feature",
            "row_ref": 2,
            "column_ref": 1,
            "field_definition_ref": 6
          },
          {
            "id": 622562724,
            "plain_value": "Designed",
            "html_value": "<span class=\"status-pill\" style=\"border-color: #ecdd8f; background-color: #F7F1D2; color: #5E5839;\">Designed</span>",
            "rich_value": {
              "id": 962984386,
              "name": "Designed",
              "color": "727272"
            },
            "row_ref": 2,
            "column_ref": 1,
            "field_definition_ref": 7
          },
          {
            "id": null,
            "plain_value": null,
            "html_value": null,
            "rich_value": null,
            "row_ref": 2,
            "column_ref": 1,
            "field_definition_ref": 8
          }
        ],
        [
          {
            "id": 303873333,
            "plain_value": "PRJ1-3",
            "html_value": "<a data-drawer-url=\"/features/PRJ1-3\" href=\"/features/PRJ1-3\">PRJ1-3</a>",
            "rich_value": "PRJ1-3",
            "row_ref": 2,
            "column_ref": 1,
            "field_definition_ref": 5
          },
          {
            "id": 303873333,
            "plain_value": "Another Third Feature",
            "html_value": "<a data-drawer-url=\"/features/PRJ1-3\" href=\"/features/PRJ1-3\">Another Third Feature</a>",
            "rich_value": "Another Third Feature",
            "row_ref": 2,
            "column_ref": 1,
            "field_definition_ref": 6
          },
          {
            "id": 303873333,
            "plain_value": "Designed",
            "html_value": "<span class=\"status-pill\" style=\"border-color: #ecdd8f; background-color: #F7F1D2; color: #5E5839;\">Designed</span>",
            "rich_value": {
              "id": 962984386,
              "name": "Designed",
              "color": "727272"
            },
            "row_ref": 2,
            "column_ref": 1,
            "field_definition_ref": 7
          },
          {
            "id": null,
            "plain_value": null,
            "html_value": null,
            "rich_value": null,
            "row_ref": 2,
            "column_ref": 1,
            "field_definition_ref": 8
          }
        ],
        [
          {
            "id": 209201304,
            "plain_value": "PRJ1-4",
            "html_value": "<a data-drawer-url=\"/features/PRJ1-4\" href=\"/features/PRJ1-4\">PRJ1-4</a>",
            "rich_value": "PRJ1-4",
            "row_ref": 2,
            "column_ref": 1,
            "field_definition_ref": 5
          },
          {
            "id": 209201304,
            "plain_value": "Another Fourth Feature",
            "html_value": "<a data-drawer-url=\"/features/PRJ1-4\" href=\"/features/PRJ1-4\">Another Fourth Feature</a>",
            "rich_value": "Another Fourth Feature",
            "row_ref": 2,
            "column_ref": 1,
            "field_definition_ref": 6
          },
          {
            "id": 209201304,
            "plain_value": "Designed",
            "html_value": "<span class=\"status-pill\" style=\"border-color: #ecdd8f; background-color: #F7F1D2; color: #5E5839;\">Designed</span>",
            "rich_value": {
              "id": 962984386,
              "name": "Designed",
              "color": "727272"
            },
            "row_ref": 2,
            "column_ref": 1,
            "field_definition_ref": 7
          },
          {
            "id": null,
            "plain_value": null,
            "html_value": null,
            "rich_value": null,
            "row_ref": 2,
            "column_ref": 1,
            "field_definition_ref": 8
          }
        ]
      ]
    ]
  ],
  "field_definitions": {
    "3": {
      "ref": 3,
      "table": "projects",
      "field": "name",
      "title": "Workspace name"
    },
    "4": {
      "ref": 4,
      "table": "releases",
      "field": "name",
      "title": "Release name"
    },
    "5": {
      "ref": 5,
      "table": "features",
      "field": "reference_num",
      "title": "Feature reference #"
    },
    "6": {
      "ref": 6,
      "table": "features",
      "field": "name",
      "title": "Feature name"
    },
    "7": {
      "ref": 7,
      "table": "features",
      "field": "status",
      "title": "Feature status"
    },
    "8": {
      "ref": 8,
      "table": "ideas",
      "field": "created_by_user_id",
      "title": "Idea created by"
    }
  }
}

Estimate values API


POST /api/v1/capacity_investments/:id/estimate_values

Create estimate values for a capacity investment

Estimate value objects should include the following keys: team_id, period_start, and total. Returns all updated and destroyed estimate values, including computed sums and ignored values.

Parameters

Name Description
id * Numeric ID of the capacity investment to add estimate values to
estimate_values * An array of estimate value objects to create

POST /api/v1/capacity_investments/756888381/estimate_values

Example CURL command

curl "https://company.aha.io/api/v1/capacity_investments/756888381/estimate_values" -d $'{"estimate_values":{"0":{"team_id":949295028,"period_start":"2019-01-01","total":5},"1":{"team_id":949295028,"period_start":"2019-01-01","total":10},"2":{"team_id":563889676,"period_start":"2019-01-01","total":15},"3":{"team_id":563889676,"period_start":"2019-01-01","total":20}}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "estimate_values": {
    "0": {
      "team_id": 949295028,
      "period_start": "2019-01-01",
      "total": 5
    },
    "1": {
      "team_id": 949295028,
      "period_start": "2019-01-01",
      "total": 10
    },
    "2": {
      "team_id": 563889676,
      "period_start": "2019-01-01",
      "total": 15
    },
    "3": {
      "team_id": 563889676,
      "period_start": "2019-01-01",
      "total": 20
    }
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "updated": [
    {
      "id": "6825596082539032133",
      "team_id": 949295028,
      "period_start": "2019-01-01",
      "total": "5.0",
      "computed": false,
      "ignored": false
    },
    {
      "id": "6825596082591713255",
      "team_id": 949295028,
      "period_start": null,
      "total": "15.0",
      "computed": true,
      "ignored": false
    },
    {
      "id": "6825596082632049797",
      "team_id": null,
      "period_start": null,
      "total": "50.0",
      "computed": true,
      "ignored": false
    },
    {
      "id": "6825596082845827148",
      "team_id": null,
      "period_start": "2019-01-01",
      "total": "5.0",
      "computed": true,
      "ignored": false
    },
    {
      "id": "6825596082891875717",
      "team_id": 949295028,
      "period_start": "2019-01-01",
      "total": "10.0",
      "computed": false,
      "ignored": false
    },
    {
      "id": "6825596083025463090",
      "team_id": null,
      "period_start": "2019-01-01",
      "total": "25.0",
      "computed": true,
      "ignored": false
    },
    {
      "id": "6825596083081736368",
      "team_id": 563889676,
      "period_start": "2019-01-01",
      "total": "15.0",
      "computed": false,
      "ignored": false
    },
    {
      "id": "6825596083129736876",
      "team_id": 563889676,
      "period_start": null,
      "total": "35.0",
      "computed": true,
      "ignored": false
    },
    {
      "id": "6825596083317177046",
      "team_id": 563889676,
      "period_start": "2019-01-01",
      "total": "20.0",
      "computed": false,
      "ignored": false
    },
    {
      "id": "6825596083450136813",
      "team_id": null,
      "period_start": "2019-01-01",
      "total": "20.0",
      "computed": true,
      "ignored": false
    }
  ],
  "destroyed": [

  ]
}

GET /api/v1/capacity_investments/:id/estimate_values

Retrieve estimate values for a capacity investment

Parameters

Name Description
id * Numeric ID of the capacity investment to retrieve estimate values for

GET /api/v1/capacity_investments/756888381/estimate_values

Example CURL command

curl -g "https://company.aha.io/api/v1/capacity_investments/756888381/estimate_values" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "estimate_values": [
    {
      "id": "6825596085020728210",
      "team_id": 563889676,
      "period_start": "2019-01-01",
      "total": "15.0",
      "computed": false,
      "ignored": false
    },
    {
      "id": "6825596085236014209",
      "team_id": 563889676,
      "period_start": "2019-01-01",
      "total": "20.0",
      "computed": false,
      "ignored": false
    },
    {
      "id": "6825596085048509671",
      "team_id": 563889676,
      "period_start": null,
      "total": "35.0",
      "computed": true,
      "ignored": false
    },
    {
      "id": "6825596084136125736",
      "team_id": 949295028,
      "period_start": "2019-01-01",
      "total": "5.0",
      "computed": false,
      "ignored": false
    },
    {
      "id": "6825596084675280771",
      "team_id": 949295028,
      "period_start": "2019-01-01",
      "total": "10.0",
      "computed": false,
      "ignored": false
    },
    {
      "id": "6825596084237241243",
      "team_id": 949295028,
      "period_start": null,
      "total": "15.0",
      "computed": true,
      "ignored": false
    },
    {
      "id": "6825596084524053483",
      "team_id": null,
      "period_start": "2019-01-01",
      "total": "5.0",
      "computed": true,
      "ignored": false
    },
    {
      "id": "6825596084871812010",
      "team_id": null,
      "period_start": "2019-01-01",
      "total": "25.0",
      "computed": true,
      "ignored": false
    },
    {
      "id": "6825596085386354929",
      "team_id": null,
      "period_start": "2019-01-01",
      "total": "20.0",
      "computed": true,
      "ignored": false
    },
    {
      "id": "6825596084296675965",
      "team_id": null,
      "period_start": null,
      "total": "50.0",
      "computed": true,
      "ignored": false
    }
  ],
  "pagination": {
    "total_records": 10,
    "total_pages": 1,
    "current_page": 1
  }
}

PUT /api/v1/estimate_values/:id

Update an estimate value

Returns all updated estimate values, including computed sums and ignored values.

Parameters

Name Description
id * Numeric ID of the estimate value to update
total Total of the estimate value

PUT /api/v1/estimate_values/6825596086406601475

Example CURL command

curl "https://company.aha.io/api/v1/estimate_values/6825596086406601475" -d $'{"estimate_value":{"total":20}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "estimate_value": {
    "total": 20
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "updated": [
    {
      "id": "6825596086406601475",
      "team_id": 949295028,
      "period_start": "2019-01-01",
      "total": "20.0",
      "computed": false,
      "ignored": false
    },
    {
      "id": "6825596086036463170",
      "team_id": 949295028,
      "period_start": null,
      "total": "25.0",
      "computed": true,
      "ignored": false
    },
    {
      "id": "6825596086085117708",
      "team_id": null,
      "period_start": null,
      "total": "60.0",
      "computed": true,
      "ignored": false
    },
    {
      "id": "6825596086561669032",
      "team_id": null,
      "period_start": "2019-01-01",
      "total": "35.0",
      "computed": true,
      "ignored": false
    }
  ],
  "destroyed": [

  ]
}

DELETE /api/v1/estimate_values/:id

Delete an estimate value

Returns all updated and destroyed estimate values, including computed sums and ignored values.

Parameters

Name Description
id * Numeric ID of the estimate value to update

DELETE /api/v1/estimate_values/6825596089060340595

Example CURL command

curl "https://company.aha.io/api/v1/estimate_values/6825596089060340595" -d $'{}' -X DELETE \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "updated": [
    {
      "id": "6825596088604090683",
      "team_id": 949295028,
      "period_start": null,
      "total": "5.0",
      "computed": true,
      "ignored": false
    },
    {
      "id": "6825596088653846299",
      "team_id": null,
      "period_start": null,
      "total": "40.0",
      "computed": true,
      "ignored": false
    },
    {
      "id": "6825596089238618184",
      "team_id": null,
      "period_start": "2019-01-01",
      "total": "15.0",
      "computed": true,
      "ignored": false
    }
  ],
  "destroyed": [
    {
      "id": "6825596089060340595",
      "team_id": 949295028,
      "period_start": "2019-01-01",
      "total": "10.0",
      "computed": false,
      "ignored": false
    }
  ]
}

GET /api/v1/capacity_investments/:id/estimate_values

Retrieve estimate values for a capacity investment

Parameters

Name Description
id * Numeric ID of the capacity investment to retrieve estimate values for

GET /api/v1/capacity_investments/756888381/estimate_values

Example CURL command

curl -g "https://company.aha.io/api/v1/capacity_investments/756888381/estimate_values" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 404 Not Found
  Content-Type: application/json; charset=utf-8
{
  "error": "Record not found."
}

Features API


Features belong to Releases. This means that if you want to create one you must scope them to a release.

You can list them all at once, or filter by release , product , or master feature. All these means of listing features can be further filtered by specific critera 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.

POST /api/v1/releases/:release_id/features

Create a feature

When creating a feature at least the name, workflow_kind and workflow_status must be specified.

Parameters

Name Alias Description
release_id * Numeric ID, or key of the release the feature should be created in
name * Title of the feature.
workflow_kind * type, kind Type of feature
workflow_status * status Status of the feature and it must be one of the valid status values for the selected product.
release Numeric ID, or key of the release the feature should be created in.
description Description of the feature and it can include HTML formatting.
created_by created_by_user Email address of user that created the feature.
assigned_to_user Email address of user that is assigned the feature.
tags Tags can be automatically assigned to the new feature. If more than one tag is used then tags should be separated by commas.
original_estimate_text Set the original estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
remaining_estimate_text Set the remaining estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
original_estimate Set the original estimated effort in minutes.
remaining_estimate Set the remaining estimated effort in minutes.
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
master_feature Name or id of master feature 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.

POST /api/v1/releases/PRJ1-R-1/features

Example CURL command

curl "https://company.aha.io/api/v1/releases/PRJ1-R-1/features" -d $'{"feature":{"name":"New name","workflow_kind":"new","workflow_status":{"name":"Designed"},"description":"\u003cp\u003eThis is the description\u003c/p\u003e","assigned_to_user":{"email":"no-reply@aha.io"}}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "feature": {
    "name": "New name",
    "workflow_kind": "new",
    "workflow_status": {
      "name": "Designed"
    },
    "description": "<p>This is the description</p>",
    "assigned_to_user": {
      "email": "no-reply@aha.io"
    }
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "feature": {
    "id": "6825596093324660583",
    "name": "New name",
    "reference_num": "PRJ1-5",
    "position": 1,
    "score": 2,
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "start_date": null,
    "due_date": null,
    "product_id": 131414752,
    "progress": null,
    "progress_source": "progress_manual",
    "workflow_kind": {
      "id": "98484309",
      "name": "New"
    },
    "workflow_status": {
      "id": "962984386",
      "name": "Designed",
      "position": 2,
      "complete": false,
      "color": "#ecdd8f"
    },
    "description": {
      "id": "6825596093420667551",
      "body": "<p>This is the description</p>",
      "created_at": "2019-01-01T00:00:00.000Z",
      "attachments": [

      ]
    },
    "attachments": [

    ],
    "integration_fields": [

    ],
    "url": "http://company.aha.io/features/PRJ1-5",
    "resource": "http://company.aha.io/api/v1/features/PRJ1-5",
    "release": {
      "id": "278327321",
      "reference_num": "PRJ1-R-1",
      "name": "Release 1",
      "start_date": "2019-01-01",
      "release_date": "2019-01-01",
      "parking_lot": false,
      "created_at": "2019-01-01T00:00:00.000Z",
      "product_id": 131414752,
      "integration_fields": [
        {
          "id": "68217473",
          "name": "id",
          "value": "777",
          "integration_id": 204584239,
          "service_name": "jira",
          "created_at": "2019-01-01T00:00:00.000Z"
        }
      ],
      "url": "http://company.aha.io/releases/PRJ1-R-1",
      "resource": "http://company.aha.io/api/v1/releases/PRJ1-R-1",
      "owner": {
        "id": "16338845",
        "name": "John Smith",
        "email": "no-reply@aha.io",
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z"
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2019-01-01T00:00:00.000Z"
      }
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z"
    },
    "assigned_to_user": {
      "id": "689956296",
      "name": "Henry Humpty",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "default_assignee": false
    },
    "requirements": [

    ],
    "goals": [

    ],
    "comments_count": 0,
    "score_facts": [

    ],
    "tags": [

    ],
    "full_tags": [

    ],
    "custom_fields": [

    ],
    "feature_links": [

    ],
    "feature_only_original_estimate": null,
    "feature_only_remaining_estimate": null,
    "feature_only_work_done": null
  }
}

POST /api/v1/releases/:release_id/features

Create a feature with assignee

Parameters

Name Alias Description
release_id * Numeric ID, or key of the release the feature should be created in
name * Title of the feature.
workflow_kind * type, kind Type of feature
workflow_status * status Status of the feature and it must be one of the valid status values for the selected product.
release Numeric ID, or key of the release the feature should be created in.
description Description of the feature and it can include HTML formatting.
created_by created_by_user Email address of user that created the feature.
assigned_to_user Email address of user that is assigned the feature.
tags Tags can be automatically assigned to the new feature. If more than one tag is used then tags should be separated by commas.
original_estimate_text Set the original estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
remaining_estimate_text Set the remaining estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
original_estimate Set the original estimated effort in minutes.
remaining_estimate Set the remaining estimated effort in minutes.
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
master_feature Name or id of master feature 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.

POST /api/v1/releases/PRJ1-R-1/features

Example CURL command

curl "https://company.aha.io/api/v1/releases/PRJ1-R-1/features" -d $'{"feature":{"name":"New feature","workflow_kind":"new","workflow_status":{"name":"Designed"},"assigned_to_user":"no-reply@aha.io"}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "feature": {
    "name": "New feature",
    "workflow_kind": "new",
    "workflow_status": {
      "name": "Designed"
    },
    "assigned_to_user": "no-reply@aha.io"
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "feature": {
    "id": "6825596094654287838",
    "name": "New feature",
    "reference_num": "PRJ1-5",
    "position": 1,
    "score": 2,
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "start_date": null,
    "due_date": null,
    "product_id": 131414752,
    "progress": null,
    "progress_source": "progress_manual",
    "workflow_kind": {
      "id": "98484309",
      "name": "New"
    },
    "workflow_status": {
      "id": "962984386",
      "name": "Designed",
      "position": 2,
      "complete": false,
      "color": "#ecdd8f"
    },
    "description": {
      "id": "6825596094704019765",
      "body": "",
      "created_at": "2019-01-01T00:00:00.000Z",
      "attachments": [

      ]
    },
    "attachments": [

    ],
    "integration_fields": [

    ],
    "url": "http://company.aha.io/features/PRJ1-5",
    "resource": "http://company.aha.io/api/v1/features/PRJ1-5",
    "release": {
      "id": "278327321",
      "reference_num": "PRJ1-R-1",
      "name": "Release 1",
      "start_date": "2019-01-01",
      "release_date": "2019-01-01",
      "parking_lot": false,
      "created_at": "2019-01-01T00:00:00.000Z",
      "product_id": 131414752,
      "integration_fields": [
        {
          "id": "68217473",
          "name": "id",
          "value": "777",
          "integration_id": 204584239,
          "service_name": "jira",
          "created_at": "2019-01-01T00:00:00.000Z"
        }
      ],
      "url": "http://company.aha.io/releases/PRJ1-R-1",
      "resource": "http://company.aha.io/api/v1/releases/PRJ1-R-1",
      "owner": {
        "id": "16338845",
        "name": "John Smith",
        "email": "no-reply@aha.io",
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z"
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2019-01-01T00:00:00.000Z"
      }
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z"
    },
    "assigned_to_user": {
      "id": "689956296",
      "name": "Henry Humpty",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "default_assignee": false
    },
    "requirements": [

    ],
    "goals": [

    ],
    "comments_count": 0,
    "score_facts": [

    ],
    "tags": [

    ],
    "full_tags": [

    ],
    "custom_fields": [

    ],
    "feature_links": [

    ],
    "feature_only_original_estimate": null,
    "feature_only_remaining_estimate": null,
    "feature_only_work_done": null
  }
}

POST /api/v1/releases/:release_id/features

Create a feature with tags

Parameters

Name Alias Description
release_id * Numeric ID, or key of the release the feature should be created in
name * Title of the feature.
workflow_kind * type, kind Type of feature
workflow_status * status Status of the feature and it must be one of the valid status values for the selected product.
release Numeric ID, or key of the release the feature should be created in.
description Description of the feature and it can include HTML formatting.
created_by created_by_user Email address of user that created the feature.
assigned_to_user Email address of user that is assigned the feature.
tags Tags can be automatically assigned to the new feature. If more than one tag is used then tags should be separated by commas.
original_estimate_text Set the original estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
remaining_estimate_text Set the remaining estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
original_estimate Set the original estimated effort in minutes.
remaining_estimate Set the remaining estimated effort in minutes.
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
master_feature Name or id of master feature 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.

POST /api/v1/releases/PRJ1-R-1/features

Example CURL command

curl "https://company.aha.io/api/v1/releases/PRJ1-R-1/features" -d $'{"feature":{"name":"New feature","workflow_kind":"new","workflow_status":{"name":"Designed"},"tags":"tag1, tag2"}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "feature": {
    "name": "New feature",
    "workflow_kind": "new",
    "workflow_status": {
      "name": "Designed"
    },
    "tags": "tag1, tag2"
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "feature": {
    "id": "6825596097095160257",
    "name": "New feature",
    "reference_num": "PRJ1-5",
    "position": 1,
    "score": 2,
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "start_date": null,
    "due_date": null,
    "product_id": 131414752,
    "progress": null,
    "progress_source": "progress_manual",
    "workflow_kind": {
      "id": "98484309",
      "name": "New"
    },
    "workflow_status": {
      "id": "962984386",
      "name": "Designed",
      "position": 2,
      "complete": false,
      "color": "#ecdd8f"
    },
    "description": {
      "id": "6825596097206184650",
      "body": "",
      "created_at": "2019-01-01T00:00:00.000Z",
      "attachments": [

      ]
    },
    "attachments": [

    ],
    "integration_fields": [

    ],
    "url": "http://company.aha.io/features/PRJ1-5",
    "resource": "http://company.aha.io/api/v1/features/PRJ1-5",
    "release": {
      "id": "278327321",
      "reference_num": "PRJ1-R-1",
      "name": "Release 1",
      "start_date": "2019-01-01",
      "release_date": "2019-01-01",
      "parking_lot": false,
      "created_at": "2019-01-01T00:00:00.000Z",
      "product_id": 131414752,
      "integration_fields": [
        {
          "id": "68217473",
          "name": "id",
          "value": "777",
          "integration_id": 204584239,
          "service_name": "jira",
          "created_at": "2019-01-01T00:00:00.000Z"
        }
      ],
      "url": "http://company.aha.io/releases/PRJ1-R-1",
      "resource": "http://company.aha.io/api/v1/releases/PRJ1-R-1",
      "owner": {
        "id": "16338845",
        "name": "John Smith",
        "email": "no-reply@aha.io",
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z"
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2019-01-01T00:00:00.000Z"
      }
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z"
    },
    "assigned_to_user": {
      "id": "689956296",
      "name": "Henry Humpty",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "default_assignee": true
    },
    "requirements": [

    ],
    "goals": [

    ],
    "comments_count": 0,
    "score_facts": [

    ],
    "tags": [
      "tag1",
      "tag2"
    ],
    "full_tags": [
      {
        "id": "6825596096954591359",
        "name": "tag1",
        "color": "#52e077"
      },
      {
        "id": "6825596096967596852",
        "name": "tag2",
        "color": "#52d3e0"
      }
    ],
    "custom_fields": [

    ],
    "feature_links": [

    ],
    "feature_only_original_estimate": null,
    "feature_only_remaining_estimate": null,
    "feature_only_work_done": null
  }
}

POST /api/v1/releases/:release_id/features

Create a feature with watchers

Parameters

Name Alias Description
release_id * Numeric ID, or key of the release the feature should be created in
name * Title of the feature.
workflow_kind * type, kind Type of feature
workflow_status * status Status of the feature and it must be one of the valid status values for the selected product.
release Numeric ID, or key of the release the feature should be created in.
description Description of the feature and it can include HTML formatting.
created_by created_by_user Email address of user that created the feature.
assigned_to_user Email address of user that is assigned the feature.
tags Tags can be automatically assigned to the new feature. If more than one tag is used then tags should be separated by commas.
original_estimate_text Set the original estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
remaining_estimate_text Set the remaining estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
original_estimate Set the original estimated effort in minutes.
remaining_estimate Set the remaining estimated effort in minutes.
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
master_feature Name or id of master feature 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.

POST /api/v1/releases/PRJ1-R-1/features

Example CURL command

curl "https://company.aha.io/api/v1/releases/PRJ1-R-1/features" -d $'{"fields":"*,watchers","feature":{"name":"New feature","workflow_kind":"new","workflow_status":{"name":"Designed"},"watchers":"689956296,16338845"}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "fields": "*,watchers",
  "feature": {
    "name": "New feature",
    "workflow_kind": "new",
    "workflow_status": {
      "name": "Designed"
    },
    "watchers": "689956296,16338845"
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "feature": {
    "id": "6825596099628557205",
    "name": "New feature",
    "reference_num": "PRJ1-5",
    "position": 1,
    "score": 2,
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "start_date": null,
    "due_date": null,
    "product_id": 131414752,
    "progress": null,
    "progress_source": "progress_manual",
    "workflow_kind": {
      "id": "98484309",
      "name": "New"
    },
    "workflow_status": {
      "id": "962984386",
      "name": "Designed",
      "position": 2,
      "complete": false,
      "color": "#ecdd8f"
    },
    "description": {
      "id": "6825596099670738480",
      "body": "",
      "created_at": "2019-01-01T00:00:00.000Z",
      "attachments": [

      ]
    },
    "attachments": [

    ],
    "integration_fields": [

    ],
    "url": "http://company.aha.io/features/PRJ1-5",
    "resource": "http://company.aha.io/api/v1/features/PRJ1-5",
    "release": {
      "id": "278327321",
      "reference_num": "PRJ1-R-1",
      "name": "Release 1",
      "start_date": "2019-01-01",
      "release_date": "2019-01-01",
      "parking_lot": false,
      "created_at": "2019-01-01T00:00:00.000Z",
      "product_id": 131414752,
      "integration_fields": [
        {
          "id": "68217473",
          "name": "id",
          "value": "777",
          "integration_id": 204584239,
          "service_name": "jira",
          "created_at": "2019-01-01T00:00:00.000Z"
        }
      ],
      "url": "http://company.aha.io/releases/PRJ1-R-1",
      "resource": "http://company.aha.io/api/v1/releases/PRJ1-R-1",
      "owner": {
        "id": "16338845",
        "name": "John Smith",
        "email": "no-reply@aha.io",
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z"
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2019-01-01T00:00:00.000Z"
      }
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z"
    },
    "assigned_to_user": {
      "id": "689956296",
      "name": "Henry Humpty",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "default_assignee": true
    },
    "requirements": [

    ],
    "goals": [

    ],
    "comments_count": 0,
    "score_facts": [

    ],
    "tags": [

    ],
    "full_tags": [

    ],
    "custom_fields": [

    ],
    "feature_links": [

    ],
    "feature_only_original_estimate": null,
    "feature_only_remaining_estimate": null,
    "feature_only_work_done": null,
    "watchers": [
      {
        "id": "16338845",
        "name": "John Smith",
        "email": "no-reply@aha.io",
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z"
      },
      {
        "id": "689956296",
        "name": "Henry Humpty",
        "email": "no-reply@aha.io",
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z"
      },
      {
        "id": "1020675218",
        "name": "Mary Humpty",
        "email": "no-reply@aha.io",
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z"
      }
    ]
  }
}

POST /api/v1/releases/:release_id/features

Create a feature with goals

Parameters

Name Alias Description
release_id * Numeric ID, or key of the release the feature should be created in
name * Title of the feature.
workflow_kind * type, kind Type of feature
workflow_status * status Status of the feature and it must be one of the valid status values for the selected product.
release Numeric ID, or key of the release the feature should be created in.
description Description of the feature and it can include HTML formatting.
created_by created_by_user Email address of user that created the feature.
assigned_to_user Email address of user that is assigned the feature.
tags Tags can be automatically assigned to the new feature. If more than one tag is used then tags should be separated by commas.
original_estimate_text Set the original estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
remaining_estimate_text Set the remaining estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
original_estimate Set the original estimated effort in minutes.
remaining_estimate Set the remaining estimated effort in minutes.
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
master_feature Name or id of master feature 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.

POST /api/v1/releases/PRJ1-R-1/features

Example CURL command

curl "https://company.aha.io/api/v1/releases/PRJ1-R-1/features" -d $'{"fields":"*,goals","feature":{"name":"New feature","workflow_kind":"new","workflow_status":{"name":"Designed"},"goals":"602095703,988418543"}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "fields": "*,goals",
  "feature": {
    "name": "New feature",
    "workflow_kind": "new",
    "workflow_status": {
      "name": "Designed"
    },
    "goals": "602095703,988418543"
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "feature": {
    "id": "6825596101027778468",
    "name": "New feature",
    "reference_num": "PRJ1-5",
    "position": 1,
    "score": 2,
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "start_date": null,
    "due_date": null,
    "product_id": 131414752,
    "progress": null,
    "progress_source": "progress_manual",
    "workflow_kind": {
      "id": "98484309",
      "name": "New"
    },
    "workflow_status": {
      "id": "962984386",
      "name": "Designed",
      "position": 2,
      "complete": false,
      "color": "#ecdd8f"
    },
    "description": {
      "id": "6825596101080667891",
      "body": "",
      "created_at": "2019-01-01T00:00:00.000Z",
      "attachments": [

      ]
    },
    "attachments": [

    ],
    "integration_fields": [

    ],
    "url": "http://company.aha.io/features/PRJ1-5",
    "resource": "http://company.aha.io/api/v1/features/PRJ1-5",
    "release": {
      "id": "278327321",
      "reference_num": "PRJ1-R-1",
      "name": "Release 1",
      "start_date": "2019-01-01",
      "release_date": "2019-01-01",
      "parking_lot": false,
      "created_at": "2019-01-01T00:00:00.000Z",
      "product_id": 131414752,
      "integration_fields": [
        {
          "id": "68217473",
          "name": "id",
          "value": "777",
          "integration_id": 204584239,
          "service_name": "jira",
          "created_at": "2019-01-01T00:00:00.000Z"
        }
      ],
      "url": "http://company.aha.io/releases/PRJ1-R-1",
      "resource": "http://company.aha.io/api/v1/releases/PRJ1-R-1",
      "owner": {
        "id": "16338845",
        "name": "John Smith",
        "email": "no-reply@aha.io",
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z"
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2019-01-01T00:00:00.000Z"
      }
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z"
    },
    "assigned_to_user": {
      "id": "689956296",
      "name": "Henry Humpty",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "default_assignee": true
    },
    "requirements": [

    ],
    "goals": [
      {
        "id": "988418543",
        "name": "Goal 2",
        "url": "http://company.aha.io/strategic_imperatives/DEMOENT-G-2",
        "resource": "http://company.aha.io/api/v1/goals/DEMOENT-G-2",
        "created_at": "2019-01-01T00:00:00.000Z",
        "description": {
          "id": "849769222",
          "body": "Description of project1_strategic_imperative2",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        }
      },
      {
        "id": "602095703",
        "name": "Goal 1",
        "url": "http://company.aha.io/strategic_imperatives/DEMOENT-G-1",
        "resource": "http://company.aha.io/api/v1/goals/DEMOENT-G-1",
        "created_at": "2019-01-01T00:00:00.000Z",
        "description": {
          "id": "258744266",
          "body": "Description of project1_strategic_imperative1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        }
      }
    ],
    "comments_count": 0,
    "score_facts": [

    ],
    "tags": [

    ],
    "full_tags": [

    ],
    "custom_fields": [

    ],
    "feature_links": [

    ],
    "feature_only_original_estimate": null,
    "feature_only_remaining_estimate": null,
    "feature_only_work_done": null
  }
}

POST /api/v1/releases/:release_id/features

Create a feature with a score

Parameters

Name Alias Description
release_id * Numeric ID, or key of the release the feature should be created in
name * Title of the feature.
workflow_kind * type, kind Type of feature
workflow_status * status Status of the feature and it must be one of the valid status values for the selected product.
release Numeric ID, or key of the release the feature should be created in.
description Description of the feature and it can include HTML formatting.
created_by created_by_user Email address of user that created the feature.
assigned_to_user Email address of user that is assigned the feature.
tags Tags can be automatically assigned to the new feature. If more than one tag is used then tags should be separated by commas.
original_estimate_text Set the original estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
remaining_estimate_text Set the remaining estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
original_estimate Set the original estimated effort in minutes.
remaining_estimate Set the remaining estimated effort in minutes.
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
master_feature Name or id of master feature 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.

POST /api/v1/releases/PRJ1-R-1/features

Example CURL command

curl "https://company.aha.io/api/v1/releases/PRJ1-R-1/features" -d $'{"feature":{"name":"New feature","workflow_kind":"new","workflow_status":{"name":"Designed"},"score_facts":[{"name":"Benefit","value":10},{"name":"Effort","value":3}]}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "feature": {
    "name": "New feature",
    "workflow_kind": "new",
    "workflow_status": {
      "name": "Designed"
    },
    "score_facts": [
      {
        "name": "Benefit",
        "value": 10
      },
      {
        "name": "Effort",
        "value": 3
      }
    ]
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "feature": {
    "id": "6825596102696616425",
    "name": "New feature",
    "reference_num": "PRJ1-5",
    "position": 1,
    "score": 13,
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "start_date": null,
    "due_date": null,
    "product_id": 131414752,
    "progress": null,
    "progress_source": "progress_manual",
    "workflow_kind": {
      "id": "98484309",
      "name": "New"
    },
    "workflow_status": {
      "id": "962984386",
      "name": "Designed",
      "position": 2,
      "complete": false,
      "color": "#ecdd8f"
    },
    "description": {
      "id": "6825596102793388502",
      "body": "",
      "created_at": "2019-01-01T00:00:00.000Z",
      "attachments": [

      ]
    },
    "attachments": [

    ],
    "integration_fields": [

    ],
    "url": "http://company.aha.io/features/PRJ1-5",
    "resource": "http://company.aha.io/api/v1/features/PRJ1-5",
    "release": {
      "id": "278327321",
      "reference_num": "PRJ1-R-1",
      "name": "Release 1",
      "start_date": "2019-01-01",
      "release_date": "2019-01-01",
      "parking_lot": false,
      "created_at": "2019-01-01T00:00:00.000Z",
      "product_id": 131414752,
      "integration_fields": [
        {
          "id": "68217473",
          "name": "id",
          "value": "777",
          "integration_id": 204584239,
          "service_name": "jira",
          "created_at": "2019-01-01T00:00:00.000Z"
        }
      ],
      "url": "http://company.aha.io/releases/PRJ1-R-1",
      "resource": "http://company.aha.io/api/v1/releases/PRJ1-R-1",
      "owner": {
        "id": "16338845",
        "name": "John Smith",
        "email": "no-reply@aha.io",
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z"
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2019-01-01T00:00:00.000Z"
      }
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z"
    },
    "assigned_to_user": {
      "id": "689956296",
      "name": "Henry Humpty",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "default_assignee": true
    },
    "requirements": [

    ],
    "goals": [

    ],
    "comments_count": 0,
    "score_facts": [
      {
        "id": "6825596102998454865",
        "value": 3,
        "name": "Effort"
      },
      {
        "id": "6825596102771224410",
        "value": 10,
        "name": "Benefit"
      }
    ],
    "tags": [

    ],
    "full_tags": [

    ],
    "custom_fields": [

    ],
    "feature_links": [

    ],
    "feature_only_original_estimate": null,
    "feature_only_remaining_estimate": null,
    "feature_only_work_done": null
  }
}

POST /api/v1/products/:product_id/features

Create a feature in the default release

Parameters

Name Alias Description
product_id * Numeric ID, or key of the product the feature should be created in
name * Title of the feature.
workflow_kind * type, kind Type of feature
workflow_status * status Status of the feature and it must be one of the valid status values for the selected product.
release Numeric ID, or key of the release the feature should be created in.
description Description of the feature and it can include HTML formatting.
created_by created_by_user Email address of user that created the feature.
assigned_to_user Email address of user that is assigned the feature.
tags Tags can be automatically assigned to the new feature. If more than one tag is used then tags should be separated by commas.
original_estimate_text Set the original estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
remaining_estimate_text Set the remaining estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
original_estimate Set the original estimated effort in minutes.
remaining_estimate Set the remaining estimated effort in minutes.
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
master_feature Name or id of master feature 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.

POST /api/v1/products/PRJ1/features

Example CURL command

curl "https://company.aha.io/api/v1/products/PRJ1/features" -d $'{"feature":{"name":"New name","workflow_kind":"new","workflow_status":{"name":"Designed"}}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "feature": {
    "name": "New name",
    "workflow_kind": "new",
    "workflow_status": {
      "name": "Designed"
    }
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "feature": {
    "id": "6825596104246443448",
    "name": "New name",
    "reference_num": "PRJ1-5",
    "position": 1,
    "score": 2,
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "start_date": null,
    "due_date": null,
    "product_id": 131414752,
    "progress": null,
    "progress_source": "progress_manual",
    "workflow_kind": {
      "id": "98484309",
      "name": "New"
    },
    "workflow_status": {
      "id": "962984386",
      "name": "Designed",
      "position": 2,
      "complete": false,
      "color": "#ecdd8f"
    },
    "description": {
      "id": "6825596104291306255",
      "body": "",
      "created_at": "2019-01-01T00:00:00.000Z",
      "attachments": [

      ]
    },
    "attachments": [

    ],
    "integration_fields": [

    ],
    "url": "http://company.aha.io/features/PRJ1-5",
    "resource": "http://company.aha.io/api/v1/features/PRJ1-5",
    "release": {
      "id": "278327321",
      "reference_num": "PRJ1-R-1",
      "name": "Release 1",
      "start_date": "2019-01-01",
      "release_date": "2019-01-01",
      "parking_lot": false,
      "created_at": "2019-01-01T00:00:00.000Z",
      "product_id": 131414752,
      "integration_fields": [
        {
          "id": "68217473",
          "name": "id",
          "value": "777",
          "integration_id": 204584239,
          "service_name": "jira",
          "created_at": "2019-01-01T00:00:00.000Z"
        }
      ],
      "url": "http://company.aha.io/releases/PRJ1-R-1",
      "resource": "http://company.aha.io/api/v1/releases/PRJ1-R-1",
      "owner": {
        "id": "16338845",
        "name": "John Smith",
        "email": "no-reply@aha.io",
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z"
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2019-01-01T00:00:00.000Z"
      }
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z"
    },
    "assigned_to_user": {
      "id": "689956296",
      "name": "Henry Humpty",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "default_assignee": true
    },
    "requirements": [

    ],
    "goals": [

    ],
    "comments_count": 0,
    "score_facts": [

    ],
    "tags": [

    ],
    "full_tags": [

    ],
    "custom_fields": [

    ],
    "feature_links": [

    ],
    "feature_only_original_estimate": null,
    "feature_only_remaining_estimate": null,
    "feature_only_work_done": null
  }
}

GET /api/v1/features

Get all features

Parameters

Name Description
q Sub-string to match against feature name

GET /api/v1/features?q=fea

Example CURL command

curl -g "https://company.aha.io/api/v1/features?q=fea" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "features": [
    {
      "id": "209201304",
      "reference_num": "PRJ1-4",
      "name": "Another Fourth Feature",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/features/PRJ1-4",
      "resource": "http://company.aha.io/api/v1/features/PRJ1-4",
      "product_id": 131414752
    },
    {
      "id": "303873333",
      "reference_num": "PRJ1-3",
      "name": "Another Third Feature",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/features/PRJ1-3",
      "resource": "http://company.aha.io/api/v1/features/PRJ1-3",
      "product_id": 131414752
    },
    {
      "id": "622562724",
      "reference_num": "PRJ1-2",
      "name": "Another Feature",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/features/PRJ1-2",
      "resource": "http://company.aha.io/api/v1/features/PRJ1-2",
      "product_id": 131414752
    },
    {
      "id": "1007868956",
      "reference_num": "PRJ1-1",
      "name": "Feature 1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/features/PRJ1-1",
      "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
      "product_id": 131414752
    }
  ],
  "pagination": {
    "total_records": 4,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/master_features/:master_feature_id/features

Get all features for a master feature

Parameters

Name Description
master_feature_id * Numeric ID, or key of the master feature to retrieve features for

GET /api/v1/master_features/PRJ1-E-1/features

Example CURL command

curl -g "https://company.aha.io/api/v1/master_features/PRJ1-E-1/features" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "features": [
    {
      "id": "1007868956",
      "reference_num": "PRJ1-1",
      "name": "Feature 1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/features/PRJ1-1",
      "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
      "product_id": 131414752
    }
  ],
  "pagination": {
    "total_records": 1,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/releases/:release_id/features

Get all features for a release

Parameters

Name Description
release_id * Numeric ID, or key of the release to retrieve features for

GET /api/v1/releases/PRJ1-R-1/features

Example CURL command

curl -g "https://company.aha.io/api/v1/releases/PRJ1-R-1/features" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "features": [
    {
      "id": "209201304",
      "reference_num": "PRJ1-4",
      "name": "Another Fourth Feature",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/features/PRJ1-4",
      "resource": "http://company.aha.io/api/v1/features/PRJ1-4",
      "product_id": 131414752
    },
    {
      "id": "303873333",
      "reference_num": "PRJ1-3",
      "name": "Another Third Feature",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/features/PRJ1-3",
      "resource": "http://company.aha.io/api/v1/features/PRJ1-3",
      "product_id": 131414752
    },
    {
      "id": "622562724",
      "reference_num": "PRJ1-2",
      "name": "Another Feature",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/features/PRJ1-2",
      "resource": "http://company.aha.io/api/v1/features/PRJ1-2",
      "product_id": 131414752
    },
    {
      "id": "1007868956",
      "reference_num": "PRJ1-1",
      "name": "Feature 1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/features/PRJ1-1",
      "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
      "product_id": 131414752
    }
  ],
  "pagination": {
    "total_records": 4,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/products/:product_id/features

Get all features for a product

Parameters

Name Description
product_id * Numeric ID, or key of the product to retrieve features for

GET /api/v1/products/PRJ1/features

Example CURL command

curl -g "https://company.aha.io/api/v1/products/PRJ1/features" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "features": [
    {
      "id": "209201304",
      "reference_num": "PRJ1-4",
      "name": "Another Fourth Feature",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/features/PRJ1-4",
      "resource": "http://company.aha.io/api/v1/features/PRJ1-4",
      "product_id": 131414752
    },
    {
      "id": "303873333",
      "reference_num": "PRJ1-3",
      "name": "Another Third Feature",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/features/PRJ1-3",
      "resource": "http://company.aha.io/api/v1/features/PRJ1-3",
      "product_id": 131414752
    },
    {
      "id": "622562724",
      "reference_num": "PRJ1-2",
      "name": "Another Feature",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/features/PRJ1-2",
      "resource": "http://company.aha.io/api/v1/features/PRJ1-2",
      "product_id": 131414752
    },
    {
      "id": "1007868956",
      "reference_num": "PRJ1-1",
      "name": "Feature 1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/features/PRJ1-1",
      "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
      "product_id": 131414752
    }
  ],
  "pagination": {
    "total_records": 4,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/goals/:goal_id/features

Get all features associated with a goal

Parameters

Name Description
goal_id * Numeric ID of the goal to get features for

GET /api/v1/goals/602095703/features

Example CURL command

curl -g "https://company.aha.io/api/v1/goals/602095703/features" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "features": [
    {
      "id": "1007868956",
      "reference_num": "PRJ1-1",
      "name": "Feature 1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/features/PRJ1-1",
      "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
      "product_id": 131414752
    }
  ],
  "pagination": {
    "total_records": 1,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/initiatives/:initiative_id/features

Get all features associated with an initiative

Parameters

Name Description
initiative_id * Numeric ID of the initiative to get features for

GET /api/v1/initiatives/423077122/features

Example CURL command

curl -g "https://company.aha.io/api/v1/initiatives/423077122/features" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "features": [
    {
      "id": "1007868956",
      "reference_num": "PRJ1-1",
      "name": "Feature 1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/features/PRJ1-1",
      "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
      "product_id": 131414752
    }
  ],
  "pagination": {
    "total_records": 1,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/features

Search features by name

Parameters

Name Description
q Sub-string to match against feature name

GET /api/v1/features?q=fea

Example CURL command

curl -g "https://company.aha.io/api/v1/features?q=fea" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "features": [
    {
      "id": "209201304",
      "reference_num": "PRJ1-4",
      "name": "Another Fourth Feature",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/features/PRJ1-4",
      "resource": "http://company.aha.io/api/v1/features/PRJ1-4",
      "product_id": 131414752
    },
    {
      "id": "303873333",
      "reference_num": "PRJ1-3",
      "name": "Another Third Feature",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/features/PRJ1-3",
      "resource": "http://company.aha.io/api/v1/features/PRJ1-3",
      "product_id": 131414752
    },
    {
      "id": "622562724",
      "reference_num": "PRJ1-2",
      "name": "Another Feature",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/features/PRJ1-2",
      "resource": "http://company.aha.io/api/v1/features/PRJ1-2",
      "product_id": 131414752
    },
    {
      "id": "1007868956",
      "reference_num": "PRJ1-1",
      "name": "Feature 1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/features/PRJ1-1",
      "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
      "product_id": 131414752
    }
  ],
  "pagination": {
    "total_records": 4,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/products/:product_id/features

Search product for features by name

Parameters

Name Description
product_id * Numeric ID, or key of the product to retrieve features for
q Sub-string to match against feature name

GET /api/v1/products/PRJ1/features?q=fea

Example CURL command

curl -g "https://company.aha.io/api/v1/products/PRJ1/features?q=fea" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "features": [
    {
      "id": "209201304",
      "reference_num": "PRJ1-4",
      "name": "Another Fourth Feature",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/features/PRJ1-4",
      "resource": "http://company.aha.io/api/v1/features/PRJ1-4",
      "product_id": 131414752
    },
    {
      "id": "303873333",
      "reference_num": "PRJ1-3",
      "name": "Another Third Feature",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/features/PRJ1-3",
      "resource": "http://company.aha.io/api/v1/features/PRJ1-3",
      "product_id": 131414752
    },
    {
      "id": "622562724",
      "reference_num": "PRJ1-2",
      "name": "Another Feature",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/features/PRJ1-2",
      "resource": "http://company.aha.io/api/v1/features/PRJ1-2",
      "product_id": 131414752
    },
    {
      "id": "1007868956",
      "reference_num": "PRJ1-1",
      "name": "Feature 1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/features/PRJ1-1",
      "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
      "product_id": 131414752
    }
  ],
  "pagination": {
    "total_records": 4,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/releases/:release_id/features

Search release for features by name

Parameters

Name Description
release_id * Numeric ID, or key of the release to retrieve features for
q Sub-string to match against feature name

GET /api/v1/releases/PRJ1-R-1/features?q=fea

Example CURL command

curl -g "https://company.aha.io/api/v1/releases/PRJ1-R-1/features?q=fea" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "features": [
    {
      "id": "209201304",
      "reference_num": "PRJ1-4",
      "name": "Another Fourth Feature",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/features/PRJ1-4",
      "resource": "http://company.aha.io/api/v1/features/PRJ1-4",
      "product_id": 131414752
    },
    {
      "id": "303873333",
      "reference_num": "PRJ1-3",
      "name": "Another Third Feature",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/features/PRJ1-3",
      "resource": "http://company.aha.io/api/v1/features/PRJ1-3",
      "product_id": 131414752
    },
    {
      "id": "622562724",
      "reference_num": "PRJ1-2",
      "name": "Another Feature",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/features/PRJ1-2",
      "resource": "http://company.aha.io/api/v1/features/PRJ1-2",
      "product_id": 131414752
    },
    {
      "id": "1007868956",
      "reference_num": "PRJ1-1",
      "name": "Feature 1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/features/PRJ1-1",
      "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
      "product_id": 131414752
    }
  ],
  "pagination": {
    "total_records": 4,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/features

Search features by modification date

Parameters

Name Description
updated_since UTC timestamp (in ISO8601 format) that the updated_at field must be larger than.

GET /api/v1/features?updated_since=2019-01-01T22%3A43%3A42Z

Example CURL command

curl -g "https://company.aha.io/api/v1/features?updated_since=2019-01-01T22%3A43%3A42Z" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "features": [
    {
      "id": "209201304",
      "reference_num": "PRJ1-4",
      "name": "Another Fourth Feature",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/features/PRJ1-4",
      "resource": "http://company.aha.io/api/v1/features/PRJ1-4",
      "product_id": 131414752
    },
    {
      "id": "303873333",
      "reference_num": "PRJ1-3",
      "name": "Another Third Feature",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/features/PRJ1-3",
      "resource": "http://company.aha.io/api/v1/features/PRJ1-3",
      "product_id": 131414752
    },
    {
      "id": "622562724",
      "reference_num": "PRJ1-2",
      "name": "Another Feature",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/features/PRJ1-2",
      "resource": "http://company.aha.io/api/v1/features/PRJ1-2",
      "product_id": 131414752
    },
    {
      "id": "1007868956",
      "reference_num": "PRJ1-1",
      "name": "Feature 1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/features/PRJ1-1",
      "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
      "product_id": 131414752
    }
  ],
  "pagination": {
    "total_records": 4,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/features

Search features by tag

Parameters

Name Description
tag A string tag value.

GET /api/v1/features?tag=Infrastructure

Example CURL command

curl -g "https://company.aha.io/api/v1/features?tag=Infrastructure" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "features": [
    {
      "id": "1007868956",
      "reference_num": "PRJ1-1",
      "name": "Feature 1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/features/PRJ1-1",
      "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
      "product_id": 131414752
    }
  ],
  "pagination": {
    "total_records": 1,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/features

Search features by assignee

Parameters

Name Description
assigned_to_user The ID or email address of user to return assigned features for.

GET /api/v1/features?assigned_to_user=no-reply@aha.io

Example CURL command

curl -g "https://company.aha.io/api/v1/features?assigned_to_user=no-reply@aha.io" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "features": [
    {
      "id": "1007868956",
      "reference_num": "PRJ1-1",
      "name": "Feature 1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/features/PRJ1-1",
      "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
      "product_id": 131414752
    }
  ],
  "pagination": {
    "total_records": 1,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/features

Search unshipped features

Parameters

Name Description
from_unshipped_releases from unshipped releases

GET /api/v1/features?from_unshipped_releases=true

Example CURL command

curl -g "https://company.aha.io/api/v1/features?from_unshipped_releases=true" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "features": [
    {
      "id": "209201304",
      "reference_num": "PRJ1-4",
      "name": "Another Fourth Feature",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/features/PRJ1-4",
      "resource": "http://company.aha.io/api/v1/features/PRJ1-4",
      "product_id": 131414752
    },
    {
      "id": "303873333",
      "reference_num": "PRJ1-3",
      "name": "Another Third Feature",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/features/PRJ1-3",
      "resource": "http://company.aha.io/api/v1/features/PRJ1-3",
      "product_id": 131414752
    },
    {
      "id": "622562724",
      "reference_num": "PRJ1-2",
      "name": "Another Feature",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/features/PRJ1-2",
      "resource": "http://company.aha.io/api/v1/features/PRJ1-2",
      "product_id": 131414752
    },
    {
      "id": "1007868956",
      "reference_num": "PRJ1-1",
      "name": "Feature 1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/features/PRJ1-1",
      "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
      "product_id": 131414752
    }
  ],
  "pagination": {
    "total_records": 4,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/features/:id

Get a specific feature

Parameters

Name Description
id * Numeric ID, or key of the feature to be retrieved

GET /api/v1/features/PRJ1-1

Example CURL command

curl -g "https://company.aha.io/api/v1/features/PRJ1-1" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "feature": {
    "id": "1007868956",
    "name": "Feature 1",
    "reference_num": "PRJ1-1",
    "position": 1,
    "score": 3,
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "start_date": "2019-01-01",
    "due_date": "2019-01-01",
    "product_id": 131414752,
    "progress": null,
    "progress_source": "progress_manual",
    "workflow_kind": {
      "id": "98484309",
      "name": "New"
    },
    "workflow_status": {
      "id": "934242751",
      "name": "New",
      "position": 1,
      "complete": false,
      "color": "#dce7c6"
    },
    "description": {
      "id": "793547626",
      "body": "Body of note 1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "attachments": [
        {
          "id": "724655692",
          "download_url": "http://company.lvh.me/attachments/724655692/token/c73d296d261f9db6f6dceb1fd641dcaad933e72d9bddfd14188b6f859dd2ef34.download?size=original",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "content_type": "text/plain",
          "file_name": "uploaded_file_name.txt",
          "file_size": 123
        }
      ]
    },
    "attachments": [

    ],
    "integration_fields": [
      {
        "id": "728894778",
        "name": "key",
        "value": "JRA-123",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2019-01-01T00:00:00.000Z"
      },
      {
        "id": "846945422",
        "name": "id",
        "value": "435",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2019-01-01T00:00:00.000Z"
      },
      {
        "id": "92040219",
        "name": "url",
        "value": "https://bigaha.atlassian.net/issues/JRA-123",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2019-01-01T00:00:00.000Z"
      }
    ],
    "url": "http://company.aha.io/features/PRJ1-1",
    "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
    "release": {
      "id": "278327321",
      "reference_num": "PRJ1-R-1",
      "name": "Release 1",
      "start_date": "2019-01-01",
      "release_date": "2019-01-01",
      "parking_lot": false,
      "created_at": "2019-01-01T00:00:00.000Z",
      "product_id": 131414752,
      "integration_fields": [
        {
          "id": "68217473",
          "name": "id",
          "value": "777",
          "integration_id": 204584239,
          "service_name": "jira",
          "created_at": "2019-01-01T00:00:00.000Z"
        }
      ],
      "url": "http://company.aha.io/releases/PRJ1-R-1",
      "resource": "http://company.aha.io/api/v1/releases/PRJ1-R-1",
      "owner": {
        "id": "16338845",
        "name": "John Smith",
        "email": "no-reply@aha.io",
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z"
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2019-01-01T00:00:00.000Z"
      }
    },
    "master_feature": {
      "id": "999605892",
      "reference_num": "PRJ1-E-1",
      "name": "Epic 1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/epics/PRJ1-E-1",
      "resource": "http://company.aha.io/api/v1/master_features/PRJ1-E-1"
    },
    "belongs_to_release_phase": {
      "id": "20526005",
      "name": "Alpha",
      "start_on": "2019-01-01",
      "end_on": "2019-01-01",
      "type": "phase",
      "release_id": 278327321,
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "progress": null,
      "progress_source": "progress_manual",
      "description": {
        "id": "243384959",
        "body": "Description of release phase 1",
        "created_at": "2019-01-01T00:00:00.000Z",
        "attachments": [

        ]
      }
    },
    "created_by_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z"
    },
    "assigned_to_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "default_assignee": false
    },
    "requirements": [
      {
        "id": "483368544",
        "name": "Body of requirement 1",
        "reference_num": "PRJ1-1-1",
        "position": 1,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "release_id": 278327321,
        "workflow_status": {
          "id": "934242751",
          "name": "New",
          "position": 1,
          "complete": false,
          "color": "#dce7c6"
        },
        "url": "http://company.aha.io/requirements/PRJ1-1-1",
        "resource": "http://company.aha.io/api/v1/requirements/PRJ1-1-1",
        "description": {
          "id": "910541534",
          "body": "Body of requirement 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": "16338845",
          "name": "John Smith",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "default_assignee": false
        },
        "created_by_user": {
          "id": "1020675218",
          "name": "Mary Humpty",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z"
        },
        "attachments": [

        ],
        "custom_fields": [
          {
            "key": "expected_completion_date",
            "name": "Expected completion date",
            "value": "2019-01-01",
            "type": "date"
          },
          {
            "key": "requested_by",
            "name": "Requested By",
            "value": "TK",
            "type": "string"
          }
        ],
        "integration_fields": [
          {
            "id": "32487847",
            "name": "key",
            "value": "JRA-987",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2019-01-01T00:00:00.000Z"
          },
          {
            "id": "417785887",
            "name": "id",
            "value": "991",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2019-01-01T00:00:00.000Z"
          }
        ],
        "comments_count": 1
      },
      {
        "id": "96915428",
        "name": "Body of requirement 2",
        "reference_num": "PRJ1-1-2",
        "position": 2,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "release_id": 278327321,
        "workflow_status": {
          "id": "1025247908",
          "name": "Shipped",
          "position": 5,
          "complete": true,
          "color": "#ecdd8f"
        },
        "url": "http://company.aha.io/requirements/PRJ1-1-2",
        "resource": "http://company.aha.io/api/v1/requirements/PRJ1-1-2",
        "description": {
          "id": "6825596117849956544",
          "body": "",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": "16338845",
          "name": "John Smith",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "default_assignee": false
        },
        "created_by_user": {
          "id": "1020675218",
          "name": "Mary Humpty",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z"
        },
        "attachments": [

        ],
        "custom_fields": [

        ],
        "integration_fields": [

        ],
        "comments_count": 0
      },
      {
        "id": "851574643",
        "name": "Body of requirement 3",
        "reference_num": "PRJ1-1-3",
        "position": 3,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "release_id": 278327321,
        "workflow_status": {
          "id": "922838743",
          "name": "Not started",
          "position": 8,
          "complete": false,
          "color": "#dce790"
        },
        "url": "http://company.aha.io/requirements/PRJ1-1-3",
        "resource": "http://company.aha.io/api/v1/requirements/PRJ1-1-3",
        "description": {
          "id": "6825596118100486708",
          "body": "",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": "16338845",
          "name": "John Smith",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "default_assignee": false
        },
        "created_by_user": {
          "id": "1020675218",
          "name": "Mary Humpty",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z"
        },
        "attachments": [

        ],
        "custom_fields": [

        ],
        "integration_fields": [

        ],
        "comments_count": 0
      }
    ],
    "initiative": {
      "id": "423077122",
      "name": "Initiative 1",
      "url": "http://company.aha.io/initiatives/PRJ1-S-1",
      "resource": "http://company.aha.io/api/v1/initiatives/PRJ1-S-1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "description": {
        "id": "1007208146",
        "body": "Description of project1_initiative1",
        "created_at": "2019-01-01T00:00:00.000Z",
        "attachments": [

        ]
      },
      "integration_fields": [
        {
          "id": "365436441",
          "name": "key",
          "value": "JRA-987222",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2019-01-01T00:00:00.000Z"
        },
        {
          "id": "213995437",
          "name": "id",
          "value": "9913333",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2019-01-01T00:00:00.000Z"
        }
      ]
    },
    "goals": [
      {
        "id": "602095703",
        "name": "Goal 1",
        "url": "http://company.aha.io/strategic_imperatives/DEMOENT-G-1",
        "resource": "http://company.aha.io/api/v1/goals/DEMOENT-G-1",
        "created_at": "2019-01-01T00:00:00.000Z",
        "description": {
          "id": "258744266",
          "body": "Description of project1_strategic_imperative1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        }
      }
    ],
    "comments_count": 1,
    "score_facts": [
      {
        "id": "728895917",
        "value": 1,
        "name": "Effort"
      },
      {
        "id": "846938137",
        "value": 2,
        "name": "Benefit"
      }
    ],
    "tags": [
      "Engineering",
      "Infrastructure"
    ],
    "full_tags": [
      {
        "id": 3412727,
        "name": "Engineering",
        "color": "#e09052"
      },
      {
        "id": 775582684,
        "name": "Infrastructure",
        "color": "#7552e0"
      }
    ],
    "custom_fields": [
      {
        "key": "expected_completion_date",
        "name": "Expected completion date",
        "value": "2019-01-01",
        "type": "date"
      },
      {
        "key": "equation_specs_field",
        "name": "Equation specs field",
        "value": {
          "values": {
            "123": {
              "value": 10,
              "display_value": "10.0"
            },
            "456": {
              "value": "Foobar",
              "display_value": "Foobar"
            },
            "789": {
              "value": null,
              "display_value": null
            }
          }
        },
        "type": "equation_sheet"
      },
      {
        "key": "negative_scorecard",
        "name": "Negative custom scorecard",
        "value": 31,
        "type": "scorecard",
        "score_facts": [
          {
            "id": "462102328",
            "value": 6,
            "name": "Negative default value"
          }
        ]
      }
    ],
    "feature_links": [
      {
        "link_type": "Depends on",
        "link_type_id": 20,
        "created_at": "2019-01-01T00:00:00.000Z",
        "parent_record": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "child_record": {
          "id": "622562724",
          "reference_num": "PRJ1-2",
          "name": "Another Feature",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-2",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-2",
          "product_id": 131414752
        }
      }
    ],
    "feature_only_original_estimate": null,
    "feature_only_remaining_estimate": null,
    "feature_only_work_done": null
  }
}

GET /api/v1/features/:id?fields=requirements_count,tasks_count

Get a specific feature with count fields

Parameters

Name Description
id * Numeric ID, or key of the feature to be retrieved

GET /api/v1/features/PRJ1-1?fields=requirements_count,tasks_count

Example CURL command

curl -g "https://company.aha.io/api/v1/features/PRJ1-1?fields=requirements_count,tasks_count" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "feature": {
    "id": "1007868956",
    "requirements_count": 3,
    "tasks_count": 1
  }
}

PUT /api/v1/features/:id

Update a feature

Parameters

Name Alias Description
id * Numeric ID, or key of the feature to be edited
name * Name of the feature
workflow_kind type, kind Type of feature
workflow_status status Status of the feature and it must be one of the valid status values for the selected product.
release Numeric ID, or key of the release the feature should be created in.
description Description of the feature and it can include HTML formatting.
created_by created_by_user Email address of user that created the feature.
assigned_to_user Email address of user that is assigned the feature.
tags Tags can be automatically assigned to the new feature. If more than one tag is used then tags should be separated by commas.
original_estimate_text Set the original estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
remaining_estimate_text Set the remaining estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
original_estimate Set the original estimated effort in minutes.
remaining_estimate Set the remaining estimated effort in minutes.
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
master_feature Name or id of master feature 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.

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
Content-Type: application/json
Accept: application/json
{
  "feature": {
    "name": "New name",
    "description": "New description"
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "feature": {
    "id": "1007868956",
    "name": "New name",
    "reference_num": "PRJ1-1",
    "position": 1,
    "score": 3,
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "start_date": "2019-01-01",
    "due_date": "2019-01-01",
    "product_id": 131414752,
    "progress": null,
    "progress_source": "progress_manual",
    "workflow_kind": {
      "id": "98484309",
      "name": "New"
    },
    "workflow_status": {
      "id": "934242751",
      "name": "New",
      "position": 1,
      "complete": false,
      "color": "#dce7c6"
    },
    "description": {
      "id": "793547626",
      "body": "New description",
      "created_at": "2019-01-01T00:00:00.000Z",
      "attachments": [
        {
          "id": "724655692",
          "download_url": "http://company.lvh.me/attachments/724655692/token/8ee9088a5cd5926955ad5b6dd2f9e6f39da4f6ed1eb03b5a9d188ea6044a325e.download?size=original",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "content_type": "text/plain",
          "file_name": "uploaded_file_name.txt",
          "file_size": 123
        }
      ]
    },
    "attachments": [

    ],
    "integration_fields": [
      {
        "id": "728894778",
        "name": "key",
        "value": "JRA-123",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2019-01-01T00:00:00.000Z"
      },
      {
        "id": "846945422",
        "name": "id",
        "value": "435",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2019-01-01T00:00:00.000Z"
      },
      {
        "id": "92040219",
        "name": "url",
        "value": "https://bigaha.atlassian.net/issues/JRA-123",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2019-01-01T00:00:00.000Z"
      }
    ],
    "url": "http://company.aha.io/features/PRJ1-1",
    "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
    "release": {
      "id": "278327321",
      "reference_num": "PRJ1-R-1",
      "name": "Release 1",
      "start_date": "2019-01-01",
      "release_date": "2019-01-01",
      "parking_lot": false,
      "created_at": "2019-01-01T00:00:00.000Z",
      "product_id": 131414752,
      "integration_fields": [
        {
          "id": "68217473",
          "name": "id",
          "value": "777",
          "integration_id": 204584239,
          "service_name": "jira",
          "created_at": "2019-01-01T00:00:00.000Z"
        }
      ],
      "url": "http://company.aha.io/releases/PRJ1-R-1",
      "resource": "http://company.aha.io/api/v1/releases/PRJ1-R-1",
      "owner": {
        "id": "16338845",
        "name": "John Smith",
        "email": "no-reply@aha.io",
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z"
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2019-01-01T00:00:00.000Z"
      }
    },
    "master_feature": {
      "id": "999605892",
      "reference_num": "PRJ1-E-1",
      "name": "Epic 1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/epics/PRJ1-E-1",
      "resource": "http://company.aha.io/api/v1/master_features/PRJ1-E-1"
    },
    "belongs_to_release_phase": {
      "id": "20526005",
      "name": "Alpha",
      "start_on": "2019-01-01",
      "end_on": "2019-01-01",
      "type": "phase",
      "release_id": 278327321,
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "progress": null,
      "progress_source": "progress_manual",
      "description": {
        "id": "243384959",
        "body": "Description of release phase 1",
        "created_at": "2019-01-01T00:00:00.000Z",
        "attachments": [

        ]
      }
    },
    "created_by_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z"
    },
    "assigned_to_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "default_assignee": false
    },
    "requirements": [
      {
        "id": "483368544",
        "name": "Body of requirement 1",
        "reference_num": "PRJ1-1-1",
        "position": 1,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "release_id": 278327321,
        "workflow_status": {
          "id": "934242751",
          "name": "New",
          "position": 1,
          "complete": false,
          "color": "#dce7c6"
        },
        "url": "http://company.aha.io/requirements/PRJ1-1-1",
        "resource": "http://company.aha.io/api/v1/requirements/PRJ1-1-1",
        "description": {
          "id": "910541534",
          "body": "Body of requirement 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "New name",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": "16338845",
          "name": "John Smith",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "default_assignee": false
        },
        "created_by_user": {
          "id": "1020675218",
          "name": "Mary Humpty",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z"
        },
        "attachments": [

        ],
        "custom_fields": [
          {
            "key": "expected_completion_date",
            "name": "Expected completion date",
            "value": "2019-01-01",
            "type": "date"
          },
          {
            "key": "requested_by",
            "name": "Requested By",
            "value": "TK",
            "type": "string"
          }
        ],
        "integration_fields": [
          {
            "id": "32487847",
            "name": "key",
            "value": "JRA-987",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2019-01-01T00:00:00.000Z"
          },
          {
            "id": "417785887",
            "name": "id",
            "value": "991",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2019-01-01T00:00:00.000Z"
          }
        ],
        "comments_count": 1
      },
      {
        "id": "96915428",
        "name": "Body of requirement 2",
        "reference_num": "PRJ1-1-2",
        "position": 2,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "release_id": 278327321,
        "workflow_status": {
          "id": "1025247908",
          "name": "Shipped",
          "position": 5,
          "complete": true,
          "color": "#ecdd8f"
        },
        "url": "http://company.aha.io/requirements/PRJ1-1-2",
        "resource": "http://company.aha.io/api/v1/requirements/PRJ1-1-2",
        "description": {
          "id": "6825596120962125756",
          "body": "",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "New name",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": "16338845",
          "name": "John Smith",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "default_assignee": false
        },
        "created_by_user": {
          "id": "1020675218",
          "name": "Mary Humpty",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z"
        },
        "attachments": [

        ],
        "custom_fields": [

        ],
        "integration_fields": [

        ],
        "comments_count": 0
      },
      {
        "id": "851574643",
        "name": "Body of requirement 3",
        "reference_num": "PRJ1-1-3",
        "position": 3,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "release_id": 278327321,
        "workflow_status": {
          "id": "922838743",
          "name": "Not started",
          "position": 8,
          "complete": false,
          "color": "#dce790"
        },
        "url": "http://company.aha.io/requirements/PRJ1-1-3",
        "resource": "http://company.aha.io/api/v1/requirements/PRJ1-1-3",
        "description": {
          "id": "6825596121295008062",
          "body": "",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "New name",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": "16338845",
          "name": "John Smith",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "default_assignee": false
        },
        "created_by_user": {
          "id": "1020675218",
          "name": "Mary Humpty",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z"
        },
        "attachments": [

        ],
        "custom_fields": [

        ],
        "integration_fields": [

        ],
        "comments_count": 0
      }
    ],
    "initiative": {
      "id": "423077122",
      "name": "Initiative 1",
      "url": "http://company.aha.io/initiatives/PRJ1-S-1",
      "resource": "http://company.aha.io/api/v1/initiatives/PRJ1-S-1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "description": {
        "id": "1007208146",
        "body": "Description of project1_initiative1",
        "created_at": "2019-01-01T00:00:00.000Z",
        "attachments": [

        ]
      },
      "integration_fields": [
        {
          "id": "365436441",
          "name": "key",
          "value": "JRA-987222",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2019-01-01T00:00:00.000Z"
        },
        {
          "id": "213995437",
          "name": "id",
          "value": "9913333",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2019-01-01T00:00:00.000Z"
        }
      ]
    },
    "goals": [
      {
        "id": "602095703",
        "name": "Goal 1",
        "url": "http://company.aha.io/strategic_imperatives/DEMOENT-G-1",
        "resource": "http://company.aha.io/api/v1/goals/DEMOENT-G-1",
        "created_at": "2019-01-01T00:00:00.000Z",
        "description": {
          "id": "258744266",
          "body": "Description of project1_strategic_imperative1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        }
      }
    ],
    "comments_count": 1,
    "score_facts": [
      {
        "id": "728895917",
        "value": 1,
        "name": "Effort"
      },
      {
        "id": "846938137",
        "value": 2,
        "name": "Benefit"
      }
    ],
    "tags": [
      "Engineering",
      "Infrastructure"
    ],
    "full_tags": [
      {
        "id": 3412727,
        "name": "Engineering",
        "color": "#e09052"
      },
      {
        "id": 775582684,
        "name": "Infrastructure",
        "color": "#7552e0"
      }
    ],
    "custom_fields": [
      {
        "key": "expected_completion_date",
        "name": "Expected completion date",
        "value": "2019-01-01",
        "type": "date"
      },
      {
        "key": "equation_specs_field",
        "name": "Equation specs field",
        "value": {
          "values": {
            "123": {
              "value": 10,
              "display_value": "10.0"
            },
            "456": {
              "value": "Foobar",
              "display_value": "Foobar"
            },
            "789": {
              "value": null,
              "display_value": null
            }
          }
        },
        "type": "equation_sheet"
      },
      {
        "key": "negative_scorecard",
        "name": "Negative custom scorecard",
        "value": 31,
        "type": "scorecard",
        "score_facts": [
          {
            "id": "462102328",
            "value": 6,
            "name": "Negative default value"
          }
        ]
      }
    ],
    "feature_links": [
      {
        "link_type": "Depends on",
        "link_type_id": 20,
        "created_at": "2019-01-01T00:00:00.000Z",
        "parent_record": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "New name",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "child_record": {
          "id": "622562724",
          "reference_num": "PRJ1-2",
          "name": "Another Feature",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-2",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-2",
          "product_id": 131414752
        }
      }
    ],
    "feature_only_original_estimate": null,
    "feature_only_remaining_estimate": null,
    "feature_only_work_done": null
  }
}

PUT /api/v1/features/:id

Update a feature's custom fields

Parameters

Name Alias Description
id * Numeric ID, or key of the feature to be edited
name * Name of the feature
workflow_kind type, kind Type of feature
workflow_status status Status of the feature and it must be one of the valid status values for the selected product.
release Numeric ID, or key of the release the feature should be created in.
description Description of the feature and it can include HTML formatting.
created_by created_by_user Email address of user that created the feature.
assigned_to_user Email address of user that is assigned the feature.
tags Tags can be automatically assigned to the new feature. If more than one tag is used then tags should be separated by commas.
original_estimate_text Set the original estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
remaining_estimate_text Set the remaining estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
original_estimate Set the original estimated effort in minutes.
remaining_estimate Set the remaining estimated effort in minutes.
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
master_feature Name or id of master feature 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.

PUT /api/v1/features/PRJ1-1

Example CURL command

curl "https://company.aha.io/api/v1/features/PRJ1-1" -d $'{"feature":{"custom_fields":{"priority":"P3"}}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "feature": {
    "custom_fields": {
      "priority": "P3"
    }
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "feature": {
    "id": "1007868956",
    "name": "Feature 1",
    "reference_num": "PRJ1-1",
    "position": 1,
    "score": 3,
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "start_date": "2019-01-01",
    "due_date": "2019-01-01",
    "product_id": 131414752,
    "progress": null,
    "progress_source": "progress_manual",
    "workflow_kind": {
      "id": "98484309",
      "name": "New"
    },
    "workflow_status": {
      "id": "934242751",
      "name": "New",
      "position": 1,
      "complete": false,
      "color": "#dce7c6"
    },
    "description": {
      "id": "793547626",
      "body": "Body of note 1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "attachments": [
        {
          "id": "724655692",
          "download_url": "http://company.lvh.me/attachments/724655692/token/2c1fe840c3a554085ec8d4907bd36912510b35a32ca7f4c43050db78578c64ac.download?size=original",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "content_type": "text/plain",
          "file_name": "uploaded_file_name.txt",
          "file_size": 123
        }
      ]
    },
    "attachments": [

    ],
    "integration_fields": [
      {
        "id": "728894778",
        "name": "key",
        "value": "JRA-123",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2019-01-01T00:00:00.000Z"
      },
      {
        "id": "846945422",
        "name": "id",
        "value": "435",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2019-01-01T00:00:00.000Z"
      },
      {
        "id": "92040219",
        "name": "url",
        "value": "https://bigaha.atlassian.net/issues/JRA-123",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2019-01-01T00:00:00.000Z"
      }
    ],
    "url": "http://company.aha.io/features/PRJ1-1",
    "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
    "release": {
      "id": "278327321",
      "reference_num": "PRJ1-R-1",
      "name": "Release 1",
      "start_date": "2019-01-01",
      "release_date": "2019-01-01",
      "parking_lot": false,
      "created_at": "2019-01-01T00:00:00.000Z",
      "product_id": 131414752,
      "integration_fields": [
        {
          "id": "68217473",
          "name": "id",
          "value": "777",
          "integration_id": 204584239,
          "service_name": "jira",
          "created_at": "2019-01-01T00:00:00.000Z"
        }
      ],
      "url": "http://company.aha.io/releases/PRJ1-R-1",
      "resource": "http://company.aha.io/api/v1/releases/PRJ1-R-1",
      "owner": {
        "id": "16338845",
        "name": "John Smith",
        "email": "no-reply@aha.io",
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z"
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2019-01-01T00:00:00.000Z"
      }
    },
    "master_feature": {
      "id": "999605892",
      "reference_num": "PRJ1-E-1",
      "name": "Epic 1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/epics/PRJ1-E-1",
      "resource": "http://company.aha.io/api/v1/master_features/PRJ1-E-1"
    },
    "belongs_to_release_phase": {
      "id": "20526005",
      "name": "Alpha",
      "start_on": "2019-01-01",
      "end_on": "2019-01-01",
      "type": "phase",
      "release_id": 278327321,
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "progress": null,
      "progress_source": "progress_manual",
      "description": {
        "id": "243384959",
        "body": "Description of release phase 1",
        "created_at": "2019-01-01T00:00:00.000Z",
        "attachments": [

        ]
      }
    },
    "created_by_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z"
    },
    "assigned_to_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "default_assignee": false
    },
    "requirements": [
      {
        "id": "483368544",
        "name": "Body of requirement 1",
        "reference_num": "PRJ1-1-1",
        "position": 1,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "release_id": 278327321,
        "workflow_status": {
          "id": "934242751",
          "name": "New",
          "position": 1,
          "complete": false,
          "color": "#dce7c6"
        },
        "url": "http://company.aha.io/requirements/PRJ1-1-1",
        "resource": "http://company.aha.io/api/v1/requirements/PRJ1-1-1",
        "description": {
          "id": "910541534",
          "body": "Body of requirement 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": "16338845",
          "name": "John Smith",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "default_assignee": false
        },
        "created_by_user": {
          "id": "1020675218",
          "name": "Mary Humpty",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z"
        },
        "attachments": [

        ],
        "custom_fields": [
          {
            "key": "expected_completion_date",
            "name": "Expected completion date",
            "value": "2019-01-01",
            "type": "date"
          },
          {
            "key": "requested_by",
            "name": "Requested By",
            "value": "TK",
            "type": "string"
          }
        ],
        "integration_fields": [
          {
            "id": "32487847",
            "name": "key",
            "value": "JRA-987",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2019-01-01T00:00:00.000Z"
          },
          {
            "id": "417785887",
            "name": "id",
            "value": "991",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2019-01-01T00:00:00.000Z"
          }
        ],
        "comments_count": 1
      },
      {
        "id": "96915428",
        "name": "Body of requirement 2",
        "reference_num": "PRJ1-1-2",
        "position": 2,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "release_id": 278327321,
        "workflow_status": {
          "id": "1025247908",
          "name": "Shipped",
          "position": 5,
          "complete": true,
          "color": "#ecdd8f"
        },
        "url": "http://company.aha.io/requirements/PRJ1-1-2",
        "resource": "http://company.aha.io/api/v1/requirements/PRJ1-1-2",
        "description": {
          "id": "6825596123744783277",
          "body": "",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": "16338845",
          "name": "John Smith",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "default_assignee": false
        },
        "created_by_user": {
          "id": "1020675218",
          "name": "Mary Humpty",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z"
        },
        "attachments": [

        ],
        "custom_fields": [

        ],
        "integration_fields": [

        ],
        "comments_count": 0
      },
      {
        "id": "851574643",
        "name": "Body of requirement 3",
        "reference_num": "PRJ1-1-3",
        "position": 3,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "release_id": 278327321,
        "workflow_status": {
          "id": "922838743",
          "name": "Not started",
          "position": 8,
          "complete": false,
          "color": "#dce790"
        },
        "url": "http://company.aha.io/requirements/PRJ1-1-3",
        "resource": "http://company.aha.io/api/v1/requirements/PRJ1-1-3",
        "description": {
          "id": "6825596124071524301",
          "body": "",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": "16338845",
          "name": "John Smith",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "default_assignee": false
        },
        "created_by_user": {
          "id": "1020675218",
          "name": "Mary Humpty",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z"
        },
        "attachments": [

        ],
        "custom_fields": [

        ],
        "integration_fields": [

        ],
        "comments_count": 0
      }
    ],
    "initiative": {
      "id": "423077122",
      "name": "Initiative 1",
      "url": "http://company.aha.io/initiatives/PRJ1-S-1",
      "resource": "http://company.aha.io/api/v1/initiatives/PRJ1-S-1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "description": {
        "id": "1007208146",
        "body": "Description of project1_initiative1",
        "created_at": "2019-01-01T00:00:00.000Z",
        "attachments": [

        ]
      },
      "integration_fields": [
        {
          "id": "365436441",
          "name": "key",
          "value": "JRA-987222",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2019-01-01T00:00:00.000Z"
        },
        {
          "id": "213995437",
          "name": "id",
          "value": "9913333",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2019-01-01T00:00:00.000Z"
        }
      ]
    },
    "goals": [
      {
        "id": "602095703",
        "name": "Goal 1",
        "url": "http://company.aha.io/strategic_imperatives/DEMOENT-G-1",
        "resource": "http://company.aha.io/api/v1/goals/DEMOENT-G-1",
        "created_at": "2019-01-01T00:00:00.000Z",
        "description": {
          "id": "258744266",
          "body": "Description of project1_strategic_imperative1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        }
      }
    ],
    "comments_count": 1,
    "score_facts": [
      {
        "id": "728895917",
        "value": 1,
        "name": "Effort"
      },
      {
        "id": "846938137",
        "value": 2,
        "name": "Benefit"
      }
    ],
    "tags": [
      "Engineering",
      "Infrastructure"
    ],
    "full_tags": [
      {
        "id": 3412727,
        "name": "Engineering",
        "color": "#e09052"
      },
      {
        "id": 775582684,
        "name": "Infrastructure",
        "color": "#7552e0"
      }
    ],
    "custom_fields": [
      {
        "key": "expected_completion_date",
        "name": "Expected completion date",
        "value": "2019-01-01",
        "type": "date"
      },
      {
        "key": "equation_specs_field",
        "name": "Equation specs field",
        "value": {
          "values": {
            "123": {
              "value": 10,
              "display_value": "10.0"
            },
            "456": {
              "value": "Foobar",
              "display_value": "Foobar"
            },
            "789": {
              "value": null,
              "display_value": null
            }
          }
        },
        "type": "equation_sheet"
      },
      {
        "key": "negative_scorecard",
        "name": "Negative custom scorecard",
        "value": 31,
        "type": "scorecard",
        "score_facts": [
          {
            "id": "462102328",
            "value": 6,
            "name": "Negative default value"
          }
        ]
      },
      {
        "key": "priority",
        "name": "Priority",
        "value": "P3",
        "type": "string"
      }
    ],
    "feature_links": [
      {
        "link_type": "Depends on",
        "link_type_id": 20,
        "created_at": "2019-01-01T00:00:00.000Z",
        "parent_record": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "child_record": {
          "id": "622562724",
          "reference_num": "PRJ1-2",
          "name": "Another Feature",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-2",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-2",
          "product_id": 131414752
        }
      }
    ],
    "feature_only_original_estimate": null,
    "feature_only_remaining_estimate": null,
    "feature_only_work_done": null
  }
}

PUT /api/v1/features/:id

Update a feature's custom fields with tag-like value

Parameters

Name Alias Description
id * Numeric ID, or key of the feature to be edited
name * Name of the feature
workflow_kind type, kind Type of feature
workflow_status status Status of the feature and it must be one of the valid status values for the selected product.
release Numeric ID, or key of the release the feature should be created in.
description Description of the feature and it can include HTML formatting.
created_by created_by_user Email address of user that created the feature.
assigned_to_user Email address of user that is assigned the feature.
tags Tags can be automatically assigned to the new feature. If more than one tag is used then tags should be separated by commas.
original_estimate_text Set the original estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
remaining_estimate_text Set the remaining estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
original_estimate Set the original estimated effort in minutes.
remaining_estimate Set the remaining estimated effort in minutes.
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
master_feature Name or id of master feature 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.

PUT /api/v1/features/PRJ1-1

Example CURL command

curl "https://company.aha.io/api/v1/features/PRJ1-1" -d $'{"feature":{"custom_fields":{"tags":["tag2","tag,3"]}}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "feature": {
    "custom_fields": {
      "tags": [
        "tag2",
        "tag,3"
      ]
    }
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "feature": {
    "id": "1007868956",
    "name": "Feature 1",
    "reference_num": "PRJ1-1",
    "position": 1,
    "score": 3,
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "start_date": "2019-01-01",
    "due_date": "2019-01-01",
    "product_id": 131414752,
    "progress": null,
    "progress_source": "progress_manual",
    "workflow_kind": {
      "id": "98484309",
      "name": "New"
    },
    "workflow_status": {
      "id": "934242751",
      "name": "New",
      "position": 1,
      "complete": false,
      "color": "#dce7c6"
    },
    "description": {
      "id": "793547626",
      "body": "Body of note 1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "attachments": [
        {
          "id": "724655692",
          "download_url": "http://company.lvh.me/attachments/724655692/token/6c4b8451f6aa3832f74999abd4bbaf67f85ad2b97d27d567feea93ab43a08ffa.download?size=original",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "content_type": "text/plain",
          "file_name": "uploaded_file_name.txt",
          "file_size": 123
        }
      ]
    },
    "attachments": [

    ],
    "integration_fields": [
      {
        "id": "728894778",
        "name": "key",
        "value": "JRA-123",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2019-01-01T00:00:00.000Z"
      },
      {
        "id": "846945422",
        "name": "id",
        "value": "435",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2019-01-01T00:00:00.000Z"
      },
      {
        "id": "92040219",
        "name": "url",
        "value": "https://bigaha.atlassian.net/issues/JRA-123",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2019-01-01T00:00:00.000Z"
      }
    ],
    "url": "http://company.aha.io/features/PRJ1-1",
    "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
    "release": {
      "id": "278327321",
      "reference_num": "PRJ1-R-1",
      "name": "Release 1",
      "start_date": "2019-01-01",
      "release_date": "2019-01-01",
      "parking_lot": false,
      "created_at": "2019-01-01T00:00:00.000Z",
      "product_id": 131414752,
      "integration_fields": [
        {
          "id": "68217473",
          "name": "id",
          "value": "777",
          "integration_id": 204584239,
          "service_name": "jira",
          "created_at": "2019-01-01T00:00:00.000Z"
        }
      ],
      "url": "http://company.aha.io/releases/PRJ1-R-1",
      "resource": "http://company.aha.io/api/v1/releases/PRJ1-R-1",
      "owner": {
        "id": "16338845",
        "name": "John Smith",
        "email": "no-reply@aha.io",
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z"
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2019-01-01T00:00:00.000Z"
      }
    },
    "master_feature": {
      "id": "999605892",
      "reference_num": "PRJ1-E-1",
      "name": "Epic 1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/epics/PRJ1-E-1",
      "resource": "http://company.aha.io/api/v1/master_features/PRJ1-E-1"
    },
    "belongs_to_release_phase": {
      "id": "20526005",
      "name": "Alpha",
      "start_on": "2019-01-01",
      "end_on": "2019-01-01",
      "type": "phase",
      "release_id": 278327321,
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "progress": null,
      "progress_source": "progress_manual",
      "description": {
        "id": "243384959",
        "body": "Description of release phase 1",
        "created_at": "2019-01-01T00:00:00.000Z",
        "attachments": [

        ]
      }
    },
    "created_by_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z"
    },
    "assigned_to_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "default_assignee": false
    },
    "requirements": [
      {
        "id": "483368544",
        "name": "Body of requirement 1",
        "reference_num": "PRJ1-1-1",
        "position": 1,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "release_id": 278327321,
        "workflow_status": {
          "id": "934242751",
          "name": "New",
          "position": 1,
          "complete": false,
          "color": "#dce7c6"
        },
        "url": "http://company.aha.io/requirements/PRJ1-1-1",
        "resource": "http://company.aha.io/api/v1/requirements/PRJ1-1-1",
        "description": {
          "id": "910541534",
          "body": "Body of requirement 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": "16338845",
          "name": "John Smith",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "default_assignee": false
        },
        "created_by_user": {
          "id": "1020675218",
          "name": "Mary Humpty",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z"
        },
        "attachments": [

        ],
        "custom_fields": [
          {
            "key": "expected_completion_date",
            "name": "Expected completion date",
            "value": "2019-01-01",
            "type": "date"
          },
          {
            "key": "requested_by",
            "name": "Requested By",
            "value": "TK",
            "type": "string"
          }
        ],
        "integration_fields": [
          {
            "id": "32487847",
            "name": "key",
            "value": "JRA-987",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2019-01-01T00:00:00.000Z"
          },
          {
            "id": "417785887",
            "name": "id",
            "value": "991",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2019-01-01T00:00:00.000Z"
          }
        ],
        "comments_count": 1
      },
      {
        "id": "96915428",
        "name": "Body of requirement 2",
        "reference_num": "PRJ1-1-2",
        "position": 2,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "release_id": 278327321,
        "workflow_status": {
          "id": "1025247908",
          "name": "Shipped",
          "position": 5,
          "complete": true,
          "color": "#ecdd8f"
        },
        "url": "http://company.aha.io/requirements/PRJ1-1-2",
        "resource": "http://company.aha.io/api/v1/requirements/PRJ1-1-2",
        "description": {
          "id": "6825596126525339486",
          "body": "",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": "16338845",
          "name": "John Smith",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "default_assignee": false
        },
        "created_by_user": {
          "id": "1020675218",
          "name": "Mary Humpty",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z"
        },
        "attachments": [

        ],
        "custom_fields": [

        ],
        "integration_fields": [

        ],
        "comments_count": 0
      },
      {
        "id": "851574643",
        "name": "Body of requirement 3",
        "reference_num": "PRJ1-1-3",
        "position": 3,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "release_id": 278327321,
        "workflow_status": {
          "id": "922838743",
          "name": "Not started",
          "position": 8,
          "complete": false,
          "color": "#dce790"
        },
        "url": "http://company.aha.io/requirements/PRJ1-1-3",
        "resource": "http://company.aha.io/api/v1/requirements/PRJ1-1-3",
        "description": {
          "id": "6825596126847711238",
          "body": "",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": "16338845",
          "name": "John Smith",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "default_assignee": false
        },
        "created_by_user": {
          "id": "1020675218",
          "name": "Mary Humpty",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z"
        },
        "attachments": [

        ],
        "custom_fields": [

        ],
        "integration_fields": [

        ],
        "comments_count": 0
      }
    ],
    "initiative": {
      "id": "423077122",
      "name": "Initiative 1",
      "url": "http://company.aha.io/initiatives/PRJ1-S-1",
      "resource": "http://company.aha.io/api/v1/initiatives/PRJ1-S-1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "description": {
        "id": "1007208146",
        "body": "Description of project1_initiative1",
        "created_at": "2019-01-01T00:00:00.000Z",
        "attachments": [

        ]
      },
      "integration_fields": [
        {
          "id": "365436441",
          "name": "key",
          "value": "JRA-987222",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2019-01-01T00:00:00.000Z"
        },
        {
          "id": "213995437",
          "name": "id",
          "value": "9913333",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2019-01-01T00:00:00.000Z"
        }
      ]
    },
    "goals": [
      {
        "id": "602095703",
        "name": "Goal 1",
        "url": "http://company.aha.io/strategic_imperatives/DEMOENT-G-1",
        "resource": "http://company.aha.io/api/v1/goals/DEMOENT-G-1",
        "created_at": "2019-01-01T00:00:00.000Z",
        "description": {
          "id": "258744266",
          "body": "Description of project1_strategic_imperative1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        }
      }
    ],
    "comments_count": 1,
    "score_facts": [
      {
        "id": "728895917",
        "value": 1,
        "name": "Effort"
      },
      {
        "id": "846938137",
        "value": 2,
        "name": "Benefit"
      }
    ],
    "tags": [
      "Engineering",
      "Infrastructure"
    ],
    "full_tags": [
      {
        "id": 3412727,
        "name": "Engineering",
        "color": "#e09052"
      },
      {
        "id": 775582684,
        "name": "Infrastructure",
        "color": "#7552e0"
      }
    ],
    "custom_fields": [
      {
        "key": "expected_completion_date",
        "name": "Expected completion date",
        "value": "2019-01-01",
        "type": "date"
      },
      {
        "key": "equation_specs_field",
        "name": "Equation specs field",
        "value": {
          "values": {
            "123": {
              "value": 10,
              "display_value": "10.0"
            },
            "456": {
              "value": "Foobar",
              "display_value": "Foobar"
            },
            "789": {
              "value": null,
              "display_value": null
            }
          }
        },
        "type": "equation_sheet"
      },
      {
        "key": "negative_scorecard",
        "name": "Negative custom scorecard",
        "value": 31,
        "type": "scorecard",
        "score_facts": [
          {
            "id": "462102328",
            "value": 6,
            "name": "Negative default value"
          }
        ]
      },
      {
        "key": "tags",
        "name": "Custom field items",
        "value": [
          "tag2",
          "tag,3"
        ],
        "type": "array"
      }
    ],
    "feature_links": [
      {
        "link_type": "Depends on",
        "link_type_id": 20,
        "created_at": "2019-01-01T00:00:00.000Z",
        "parent_record": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "child_record": {
          "id": "622562724",
          "reference_num": "PRJ1-2",
          "name": "Another Feature",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-2",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-2",
          "product_id": 131414752
        }
      }
    ],
    "feature_only_original_estimate": null,
    "feature_only_remaining_estimate": null,
    "feature_only_work_done": null
  }
}

PUT /api/v1/features/:id

Update a feature's custom worksheet fields

Parameters

Name Alias Description
id * Numeric ID, or key of the feature to be edited
name * Name of the feature
workflow_kind type, kind Type of feature
workflow_status status Status of the feature and it must be one of the valid status values for the selected product.
release Numeric ID, or key of the release the feature should be created in.
description Description of the feature and it can include HTML formatting.
created_by created_by_user Email address of user that created the feature.
assigned_to_user Email address of user that is assigned the feature.
tags Tags can be automatically assigned to the new feature. If more than one tag is used then tags should be separated by commas.
original_estimate_text Set the original estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
remaining_estimate_text Set the remaining estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
original_estimate Set the original estimated effort in minutes.
remaining_estimate Set the remaining estimated effort in minutes.
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
master_feature Name or id of master feature 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.

PUT /api/v1/features/PRJ1-1

Example CURL command

curl "https://company.aha.io/api/v1/features/PRJ1-1" -d $'{"feature":{"custom_fields":{"equation_custom_field":{"6651670327076753738":777.0,"6651670366942086967":432.0}}}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "feature": {
    "custom_fields": {
      "equation_custom_field": {
        "6651670327076753738": 777.0,
        "6651670366942086967": 432.0
      }
    }
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "feature": {
    "id": "1007868956",
    "name": "Feature 1",
    "reference_num": "PRJ1-1",
    "position": 1,
    "score": 3,
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "start_date": "2019-01-01",
    "due_date": "2019-01-01",
    "product_id": 131414752,
    "progress": null,
    "progress_source": "progress_manual",
    "workflow_kind": {
      "id": "98484309",
      "name": "New"
    },
    "workflow_status": {
      "id": "934242751",
      "name": "New",
      "position": 1,
      "complete": false,
      "color": "#dce7c6"
    },
    "description": {
      "id": "793547626",
      "body": "Body of note 1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "attachments": [
        {
          "id": "724655692",
          "download_url": "http://company.lvh.me/attachments/724655692/token/c084c47bd5eea6330ee4ad50134f904e47f1d5d0633135e81ca76cb392eeb8df.download?size=original",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "content_type": "text/plain",
          "file_name": "uploaded_file_name.txt",
          "file_size": 123
        }
      ]
    },
    "attachments": [

    ],
    "integration_fields": [
      {
        "id": "728894778",
        "name": "key",
        "value": "JRA-123",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2019-01-01T00:00:00.000Z"
      },
      {
        "id": "846945422",
        "name": "id",
        "value": "435",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2019-01-01T00:00:00.000Z"
      },
      {
        "id": "92040219",
        "name": "url",
        "value": "https://bigaha.atlassian.net/issues/JRA-123",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2019-01-01T00:00:00.000Z"
      }
    ],
    "url": "http://company.aha.io/features/PRJ1-1",
    "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
    "release": {
      "id": "278327321",
      "reference_num": "PRJ1-R-1",
      "name": "Release 1",
      "start_date": "2019-01-01",
      "release_date": "2019-01-01",
      "parking_lot": false,
      "created_at": "2019-01-01T00:00:00.000Z",
      "product_id": 131414752,
      "integration_fields": [
        {
          "id": "68217473",
          "name": "id",
          "value": "777",
          "integration_id": 204584239,
          "service_name": "jira",
          "created_at": "2019-01-01T00:00:00.000Z"
        }
      ],
      "url": "http://company.aha.io/releases/PRJ1-R-1",
      "resource": "http://company.aha.io/api/v1/releases/PRJ1-R-1",
      "owner": {
        "id": "16338845",
        "name": "John Smith",
        "email": "no-reply@aha.io",
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z"
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2019-01-01T00:00:00.000Z"
      }
    },
    "master_feature": {
      "id": "999605892",
      "reference_num": "PRJ1-E-1",
      "name": "Epic 1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/epics/PRJ1-E-1",
      "resource": "http://company.aha.io/api/v1/master_features/PRJ1-E-1"
    },
    "belongs_to_release_phase": {
      "id": "20526005",
      "name": "Alpha",
      "start_on": "2019-01-01",
      "end_on": "2019-01-01",
      "type": "phase",
      "release_id": 278327321,
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "progress": null,
      "progress_source": "progress_manual",
      "description": {
        "id": "243384959",
        "body": "Description of release phase 1",
        "created_at": "2019-01-01T00:00:00.000Z",
        "attachments": [

        ]
      }
    },
    "created_by_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z"
    },
    "assigned_to_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "default_assignee": false
    },
    "requirements": [
      {
        "id": "483368544",
        "name": "Body of requirement 1",
        "reference_num": "PRJ1-1-1",
        "position": 1,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "release_id": 278327321,
        "workflow_status": {
          "id": "934242751",
          "name": "New",
          "position": 1,
          "complete": false,
          "color": "#dce7c6"
        },
        "url": "http://company.aha.io/requirements/PRJ1-1-1",
        "resource": "http://company.aha.io/api/v1/requirements/PRJ1-1-1",
        "description": {
          "id": "910541534",
          "body": "Body of requirement 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": "16338845",
          "name": "John Smith",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "default_assignee": false
        },
        "created_by_user": {
          "id": "1020675218",
          "name": "Mary Humpty",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z"
        },
        "attachments": [

        ],
        "custom_fields": [
          {
            "key": "expected_completion_date",
            "name": "Expected completion date",
            "value": "2019-01-01",
            "type": "date"
          },
          {
            "key": "requested_by",
            "name": "Requested By",
            "value": "TK",
            "type": "string"
          }
        ],
        "integration_fields": [
          {
            "id": "32487847",
            "name": "key",
            "value": "JRA-987",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2019-01-01T00:00:00.000Z"
          },
          {
            "id": "417785887",
            "name": "id",
            "value": "991",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2019-01-01T00:00:00.000Z"
          }
        ],
        "comments_count": 1
      },
      {
        "id": "96915428",
        "name": "Body of requirement 2",
        "reference_num": "PRJ1-1-2",
        "position": 2,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "release_id": 278327321,
        "workflow_status": {
          "id": "1025247908",
          "name": "Shipped",
          "position": 5,
          "complete": true,
          "color": "#ecdd8f"
        },
        "url": "http://company.aha.io/requirements/PRJ1-1-2",
        "resource": "http://company.aha.io/api/v1/requirements/PRJ1-1-2",
        "description": {
          "id": "6825596129339221939",
          "body": "",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": "16338845",
          "name": "John Smith",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "default_assignee": false
        },
        "created_by_user": {
          "id": "1020675218",
          "name": "Mary Humpty",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z"
        },
        "attachments": [

        ],
        "custom_fields": [

        ],
        "integration_fields": [

        ],
        "comments_count": 0
      },
      {
        "id": "851574643",
        "name": "Body of requirement 3",
        "reference_num": "PRJ1-1-3",
        "position": 3,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "release_id": 278327321,
        "workflow_status": {
          "id": "922838743",
          "name": "Not started",
          "position": 8,
          "complete": false,
          "color": "#dce790"
        },
        "url": "http://company.aha.io/requirements/PRJ1-1-3",
        "resource": "http://company.aha.io/api/v1/requirements/PRJ1-1-3",
        "description": {
          "id": "6825596129669917488",
          "body": "",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": "16338845",
          "name": "John Smith",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "default_assignee": false
        },
        "created_by_user": {
          "id": "1020675218",
          "name": "Mary Humpty",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z"
        },
        "attachments": [

        ],
        "custom_fields": [

        ],
        "integration_fields": [

        ],
        "comments_count": 0
      }
    ],
    "initiative": {
      "id": "423077122",
      "name": "Initiative 1",
      "url": "http://company.aha.io/initiatives/PRJ1-S-1",
      "resource": "http://company.aha.io/api/v1/initiatives/PRJ1-S-1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "description": {
        "id": "1007208146",
        "body": "Description of project1_initiative1",
        "created_at": "2019-01-01T00:00:00.000Z",
        "attachments": [

        ]
      },
      "integration_fields": [
        {
          "id": "365436441",
          "name": "key",
          "value": "JRA-987222",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2019-01-01T00:00:00.000Z"
        },
        {
          "id": "213995437",
          "name": "id",
          "value": "9913333",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2019-01-01T00:00:00.000Z"
        }
      ]
    },
    "goals": [
      {
        "id": "602095703",
        "name": "Goal 1",
        "url": "http://company.aha.io/strategic_imperatives/DEMOENT-G-1",
        "resource": "http://company.aha.io/api/v1/goals/DEMOENT-G-1",
        "created_at": "2019-01-01T00:00:00.000Z",
        "description": {
          "id": "258744266",
          "body": "Description of project1_strategic_imperative1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        }
      }
    ],
    "comments_count": 1,
    "score_facts": [
      {
        "id": "728895917",
        "value": 1,
        "name": "Effort"
      },
      {
        "id": "846938137",
        "value": 2,
        "name": "Benefit"
      }
    ],
    "tags": [
      "Engineering",
      "Infrastructure"
    ],
    "full_tags": [
      {
        "id": 3412727,
        "name": "Engineering",
        "color": "#e09052"
      },
      {
        "id": 775582684,
        "name": "Infrastructure",
        "color": "#7552e0"
      }
    ],
    "custom_fields": [
      {
        "key": "expected_completion_date",
        "name": "Expected completion date",
        "value": "2019-01-01",
        "type": "date"
      },
      {
        "key": "equation_specs_field",
        "name": "Equation specs field",
        "value": {
          "values": {
            "123": {
              "value": 10,
              "display_value": "10.0"
            },
            "456": {
              "value": "Foobar",
              "display_value": "Foobar"
            },
            "789": {
              "value": null,
              "display_value": null
            }
          }
        },
        "type": "equation_sheet"
      },
      {
        "key": "negative_scorecard",
        "name": "Negative custom scorecard",
        "value": 31,
        "type": "scorecard",
        "score_facts": [
          {
            "id": "462102328",
            "value": 6,
            "name": "Negative default value"
          }
        ]
      },
      {
        "key": "equation_custom_field",
        "name": "Equation custom field",
        "value": {
          "values": {
            "6651670327076753738": {
              "value": 777.0,
              "display_value": "777.0"
            },
            "6651670366942086967": {
              "value": 432.0,
              "display_value": "432.0"
            },
            "6651670393424268679": {
              "value": 345.0,
              "display_value": "345.0"
            }
          }
        },
        "type": "equation_sheet"
      }
    ],
    "feature_links": [
      {
        "link_type": "Depends on",
        "link_type_id": 20,
        "created_at": "2019-01-01T00:00:00.000Z",
        "parent_record": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "child_record": {
          "id": "622562724",
          "reference_num": "PRJ1-2",
          "name": "Another Feature",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-2",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-2",
          "product_id": 131414752
        }
      }
    ],
    "feature_only_original_estimate": null,
    "feature_only_remaining_estimate": null,
    "feature_only_work_done": null
  }
}

PUT /api/v1/features/:id

Update a feature's tags with comma-separated values

Parameters

Name Alias Description
id * Numeric ID, or key of the feature to be edited
name * Name of the feature
workflow_kind type, kind Type of feature
workflow_status status Status of the feature and it must be one of the valid status values for the selected product.
release Numeric ID, or key of the release the feature should be created in.
description Description of the feature and it can include HTML formatting.
created_by created_by_user Email address of user that created the feature.
assigned_to_user Email address of user that is assigned the feature.
tags Tags can be automatically assigned to the new feature. If more than one tag is used then tags should be separated by commas.
original_estimate_text Set the original estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
remaining_estimate_text Set the remaining estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
original_estimate Set the original estimated effort in minutes.
remaining_estimate Set the remaining estimated effort in minutes.
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
master_feature Name or id of master feature 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.

PUT /api/v1/features/PRJ1-1

Example CURL command

curl "https://company.aha.io/api/v1/features/PRJ1-1" -d $'{"feature":{"tags":"tag2, tag3"}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "feature": {
    "tags": "tag2, tag3"
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "feature": {
    "id": "1007868956",
    "name": "Feature 1",
    "reference_num": "PRJ1-1",
    "position": 1,
    "score": 3,
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "start_date": "2019-01-01",
    "due_date": "2019-01-01",
    "product_id": 131414752,
    "progress": null,
    "progress_source": "progress_manual",
    "workflow_kind": {
      "id": "98484309",
      "name": "New"
    },
    "workflow_status": {
      "id": "934242751",
      "name": "New",
      "position": 1,
      "complete": false,
      "color": "#dce7c6"
    },
    "description": {
      "id": "793547626",
      "body": "Body of note 1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "attachments": [
        {
          "id": "724655692",
          "download_url": "http://company.lvh.me/attachments/724655692/token/05e08458fb85cb388c817e89cd45c2d66f80db1f372a27be6b1d498a583862c3.download?size=original",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "content_type": "text/plain",
          "file_name": "uploaded_file_name.txt",
          "file_size": 123
        }
      ]
    },
    "attachments": [

    ],
    "integration_fields": [
      {
        "id": "728894778",
        "name": "key",
        "value": "JRA-123",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2019-01-01T00:00:00.000Z"
      },
      {
        "id": "846945422",
        "name": "id",
        "value": "435",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2019-01-01T00:00:00.000Z"
      },
      {
        "id": "92040219",
        "name": "url",
        "value": "https://bigaha.atlassian.net/issues/JRA-123",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2019-01-01T00:00:00.000Z"
      }
    ],
    "url": "http://company.aha.io/features/PRJ1-1",
    "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
    "release": {
      "id": "278327321",
      "reference_num": "PRJ1-R-1",
      "name": "Release 1",
      "start_date": "2019-01-01",
      "release_date": "2019-01-01",
      "parking_lot": false,
      "created_at": "2019-01-01T00:00:00.000Z",
      "product_id": 131414752,
      "integration_fields": [
        {
          "id": "68217473",
          "name": "id",
          "value": "777",
          "integration_id": 204584239,
          "service_name": "jira",
          "created_at": "2019-01-01T00:00:00.000Z"
        }
      ],
      "url": "http://company.aha.io/releases/PRJ1-R-1",
      "resource": "http://company.aha.io/api/v1/releases/PRJ1-R-1",
      "owner": {
        "id": "16338845",
        "name": "John Smith",
        "email": "no-reply@aha.io",
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z"
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2019-01-01T00:00:00.000Z"
      }
    },
    "master_feature": {
      "id": "999605892",
      "reference_num": "PRJ1-E-1",
      "name": "Epic 1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/epics/PRJ1-E-1",
      "resource": "http://company.aha.io/api/v1/master_features/PRJ1-E-1"
    },
    "belongs_to_release_phase": {
      "id": "20526005",
      "name": "Alpha",
      "start_on": "2019-01-01",
      "end_on": "2019-01-01",
      "type": "phase",
      "release_id": 278327321,
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "progress": null,
      "progress_source": "progress_manual",
      "description": {
        "id": "243384959",
        "body": "Description of release phase 1",
        "created_at": "2019-01-01T00:00:00.000Z",
        "attachments": [

        ]
      }
    },
    "created_by_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z"
    },
    "assigned_to_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "default_assignee": false
    },
    "requirements": [
      {
        "id": "483368544",
        "name": "Body of requirement 1",
        "reference_num": "PRJ1-1-1",
        "position": 1,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "release_id": 278327321,
        "workflow_status": {
          "id": "934242751",
          "name": "New",
          "position": 1,
          "complete": false,
          "color": "#dce7c6"
        },
        "url": "http://company.aha.io/requirements/PRJ1-1-1",
        "resource": "http://company.aha.io/api/v1/requirements/PRJ1-1-1",
        "description": {
          "id": "910541534",
          "body": "Body of requirement 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": "16338845",
          "name": "John Smith",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "default_assignee": false
        },
        "created_by_user": {
          "id": "1020675218",
          "name": "Mary Humpty",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z"
        },
        "attachments": [

        ],
        "custom_fields": [
          {
            "key": "expected_completion_date",
            "name": "Expected completion date",
            "value": "2019-01-01",
            "type": "date"
          },
          {
            "key": "requested_by",
            "name": "Requested By",
            "value": "TK",
            "type": "string"
          }
        ],
        "integration_fields": [
          {
            "id": "32487847",
            "name": "key",
            "value": "JRA-987",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2019-01-01T00:00:00.000Z"
          },
          {
            "id": "417785887",
            "name": "id",
            "value": "991",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2019-01-01T00:00:00.000Z"
          }
        ],
        "comments_count": 1
      },
      {
        "id": "96915428",
        "name": "Body of requirement 2",
        "reference_num": "PRJ1-1-2",
        "position": 2,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "release_id": 278327321,
        "workflow_status": {
          "id": "1025247908",
          "name": "Shipped",
          "position": 5,
          "complete": true,
          "color": "#ecdd8f"
        },
        "url": "http://company.aha.io/requirements/PRJ1-1-2",
        "resource": "http://company.aha.io/api/v1/requirements/PRJ1-1-2",
        "description": {
          "id": "6825596131871562361",
          "body": "",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": "16338845",
          "name": "John Smith",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "default_assignee": false
        },
        "created_by_user": {
          "id": "1020675218",
          "name": "Mary Humpty",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z"
        },
        "attachments": [

        ],
        "custom_fields": [

        ],
        "integration_fields": [

        ],
        "comments_count": 0
      },
      {
        "id": "851574643",
        "name": "Body of requirement 3",
        "reference_num": "PRJ1-1-3",
        "position": 3,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "release_id": 278327321,
        "workflow_status": {
          "id": "922838743",
          "name": "Not started",
          "position": 8,
          "complete": false,
          "color": "#dce790"
        },
        "url": "http://company.aha.io/requirements/PRJ1-1-3",
        "resource": "http://company.aha.io/api/v1/requirements/PRJ1-1-3",
        "description": {
          "id": "6825596132155345411",
          "body": "",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": "16338845",
          "name": "John Smith",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "default_assignee": false
        },
        "created_by_user": {
          "id": "1020675218",
          "name": "Mary Humpty",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z"
        },
        "attachments": [

        ],
        "custom_fields": [

        ],
        "integration_fields": [

        ],
        "comments_count": 0
      }
    ],
    "initiative": {
      "id": "423077122",
      "name": "Initiative 1",
      "url": "http://company.aha.io/initiatives/PRJ1-S-1",
      "resource": "http://company.aha.io/api/v1/initiatives/PRJ1-S-1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "description": {
        "id": "1007208146",
        "body": "Description of project1_initiative1",
        "created_at": "2019-01-01T00:00:00.000Z",
        "attachments": [

        ]
      },
      "integration_fields": [
        {
          "id": "365436441",
          "name": "key",
          "value": "JRA-987222",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2019-01-01T00:00:00.000Z"
        },
        {
          "id": "213995437",
          "name": "id",
          "value": "9913333",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2019-01-01T00:00:00.000Z"
        }
      ]
    },
    "goals": [
      {
        "id": "602095703",
        "name": "Goal 1",
        "url": "http://company.aha.io/strategic_imperatives/DEMOENT-G-1",
        "resource": "http://company.aha.io/api/v1/goals/DEMOENT-G-1",
        "created_at": "2019-01-01T00:00:00.000Z",
        "description": {
          "id": "258744266",
          "body": "Description of project1_strategic_imperative1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        }
      }
    ],
    "comments_count": 1,
    "score_facts": [
      {
        "id": "728895917",
        "value": 1,
        "name": "Effort"
      },
      {
        "id": "846938137",
        "value": 2,
        "name": "Benefit"
      }
    ],
    "tags": [
      "tag2",
      "tag3"
    ],
    "full_tags": [
      {
        "id": "6825596130726313693",
        "name": "tag2",
        "color": "#52d3e0"
      },
      {
        "id": "6825596130744089111",
        "name": "tag3",
        "color": "#bb52e0"
      }
    ],
    "custom_fields": [
      {
        "key": "expected_completion_date",
        "name": "Expected completion date",
        "value": "2019-01-01",
        "type": "date"
      },
      {
        "key": "equation_specs_field",
        "name": "Equation specs field",
        "value": {
          "values": {
            "123": {
              "value": 10,
              "display_value": "10.0"
            },
            "456": {
              "value": "Foobar",
              "display_value": "Foobar"
            },
            "789": {
              "value": null,
              "display_value": null
            }
          }
        },
        "type": "equation_sheet"
      },
      {
        "key": "negative_scorecard",
        "name": "Negative custom scorecard",
        "value": 31,
        "type": "scorecard",
        "score_facts": [
          {
            "id": "462102328",
            "value": 6,
            "name": "Negative default value"
          }
        ]
      }
    ],
    "feature_links": [
      {
        "link_type": "Depends on",
        "link_type_id": 20,
        "created_at": "2019-01-01T00:00:00.000Z",
        "parent_record": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "child_record": {
          "id": "622562724",
          "reference_num": "PRJ1-2",
          "name": "Another Feature",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-2",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-2",
          "product_id": 131414752
        }
      }
    ],
    "feature_only_original_estimate": null,
    "feature_only_remaining_estimate": null,
    "feature_only_work_done": null
  }
}

PUT /api/v1/features/:id

Update a feature's tags with an array

Parameters

Name Alias Description
id * Numeric ID, or key of the feature to be edited
name * Name of the feature
workflow_kind type, kind Type of feature
workflow_status status Status of the feature and it must be one of the valid status values for the selected product.
release Numeric ID, or key of the release the feature should be created in.
description Description of the feature and it can include HTML formatting.
created_by created_by_user Email address of user that created the feature.
assigned_to_user Email address of user that is assigned the feature.
tags Tags can be automatically assigned to the new feature. If more than one tag is used then tags should be separated by commas.
original_estimate_text Set the original estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
remaining_estimate_text Set the remaining estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
original_estimate Set the original estimated effort in minutes.
remaining_estimate Set the remaining estimated effort in minutes.
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
master_feature Name or id of master feature 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.

PUT /api/v1/features/PRJ1-1

Example CURL command

curl "https://company.aha.io/api/v1/features/PRJ1-1" -d $'{"feature":{"tags":["tag2","tag3"]}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "feature": {
    "tags": [
      "tag2",
      "tag3"
    ]
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "feature": {
    "id": "1007868956",
    "name": "Feature 1",
    "reference_num": "PRJ1-1",
    "position": 1,
    "score": 3,
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "start_date": "2019-01-01",
    "due_date": "2019-01-01",
    "product_id": 131414752,
    "progress": null,
    "progress_source": "progress_manual",
    "workflow_kind": {
      "id": "98484309",
      "name": "New"
    },
    "workflow_status": {
      "id": "934242751",
      "name": "New",
      "position": 1,
      "complete": false,
      "color": "#dce7c6"
    },
    "description": {
      "id": "793547626",
      "body": "Body of note 1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "attachments": [
        {
          "id": "724655692",
          "download_url": "http://company.lvh.me/attachments/724655692/token/83609f6c1755ffaf77192319c5ea19738fcde652082377873c5b6d544bc36fb6.download?size=original",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "content_type": "text/plain",
          "file_name": "uploaded_file_name.txt",
          "file_size": 123
        }
      ]
    },
    "attachments": [

    ],
    "integration_fields": [
      {
        "id": "728894778",
        "name": "key",
        "value": "JRA-123",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2019-01-01T00:00:00.000Z"
      },
      {
        "id": "846945422",
        "name": "id",
        "value": "435",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2019-01-01T00:00:00.000Z"
      },
      {
        "id": "92040219",
        "name": "url",
        "value": "https://bigaha.atlassian.net/issues/JRA-123",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2019-01-01T00:00:00.000Z"
      }
    ],
    "url": "http://company.aha.io/features/PRJ1-1",
    "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
    "release": {
      "id": "278327321",
      "reference_num": "PRJ1-R-1",
      "name": "Release 1",
      "start_date": "2019-01-01",
      "release_date": "2019-01-01",
      "parking_lot": false,
      "created_at": "2019-01-01T00:00:00.000Z",
      "product_id": 131414752,
      "integration_fields": [
        {
          "id": "68217473",
          "name": "id",
          "value": "777",
          "integration_id": 204584239,
          "service_name": "jira",
          "created_at": "2019-01-01T00:00:00.000Z"
        }
      ],
      "url": "http://company.aha.io/releases/PRJ1-R-1",
      "resource": "http://company.aha.io/api/v1/releases/PRJ1-R-1",
      "owner": {
        "id": "16338845",
        "name": "John Smith",
        "email": "no-reply@aha.io",
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z"
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2019-01-01T00:00:00.000Z"
      }
    },
    "master_feature": {
      "id": "999605892",
      "reference_num": "PRJ1-E-1",
      "name": "Epic 1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/epics/PRJ1-E-1",
      "resource": "http://company.aha.io/api/v1/master_features/PRJ1-E-1"
    },
    "belongs_to_release_phase": {
      "id": "20526005",
      "name": "Alpha",
      "start_on": "2019-01-01",
      "end_on": "2019-01-01",
      "type": "phase",
      "release_id": 278327321,
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "progress": null,
      "progress_source": "progress_manual",
      "description": {
        "id": "243384959",
        "body": "Description of release phase 1",
        "created_at": "2019-01-01T00:00:00.000Z",
        "attachments": [

        ]
      }
    },
    "created_by_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z"
    },
    "assigned_to_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "default_assignee": false
    },
    "requirements": [
      {
        "id": "483368544",
        "name": "Body of requirement 1",
        "reference_num": "PRJ1-1-1",
        "position": 1,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "release_id": 278327321,
        "workflow_status": {
          "id": "934242751",
          "name": "New",
          "position": 1,
          "complete": false,
          "color": "#dce7c6"
        },
        "url": "http://company.aha.io/requirements/PRJ1-1-1",
        "resource": "http://company.aha.io/api/v1/requirements/PRJ1-1-1",
        "description": {
          "id": "910541534",
          "body": "Body of requirement 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": "16338845",
          "name": "John Smith",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "default_assignee": false
        },
        "created_by_user": {
          "id": "1020675218",
          "name": "Mary Humpty",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z"
        },
        "attachments": [

        ],
        "custom_fields": [
          {
            "key": "expected_completion_date",
            "name": "Expected completion date",
            "value": "2019-01-01",
            "type": "date"
          },
          {
            "key": "requested_by",
            "name": "Requested By",
            "value": "TK",
            "type": "string"
          }
        ],
        "integration_fields": [
          {
            "id": "32487847",
            "name": "key",
            "value": "JRA-987",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2019-01-01T00:00:00.000Z"
          },
          {
            "id": "417785887",
            "name": "id",
            "value": "991",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2019-01-01T00:00:00.000Z"
          }
        ],
        "comments_count": 1
      },
      {
        "id": "96915428",
        "name": "Body of requirement 2",
        "reference_num": "PRJ1-1-2",
        "position": 2,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "release_id": 278327321,
        "workflow_status": {
          "id": "1025247908",
          "name": "Shipped",
          "position": 5,
          "complete": true,
          "color": "#ecdd8f"
        },
        "url": "http://company.aha.io/requirements/PRJ1-1-2",
        "resource": "http://company.aha.io/api/v1/requirements/PRJ1-1-2",
        "description": {
          "id": "6825596134518385590",
          "body": "",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": "16338845",
          "name": "John Smith",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "default_assignee": false
        },
        "created_by_user": {
          "id": "1020675218",
          "name": "Mary Humpty",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z"
        },
        "attachments": [

        ],
        "custom_fields": [

        ],
        "integration_fields": [

        ],
        "comments_count": 0
      },
      {
        "id": "851574643",
        "name": "Body of requirement 3",
        "reference_num": "PRJ1-1-3",
        "position": 3,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "release_id": 278327321,
        "workflow_status": {
          "id": "922838743",
          "name": "Not started",
          "position": 8,
          "complete": false,
          "color": "#dce790"
        },
        "url": "http://company.aha.io/requirements/PRJ1-1-3",
        "resource": "http://company.aha.io/api/v1/requirements/PRJ1-1-3",
        "description": {
          "id": "6825596134848177323",
          "body": "",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": "16338845",
          "name": "John Smith",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "default_assignee": false
        },
        "created_by_user": {
          "id": "1020675218",
          "name": "Mary Humpty",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z"
        },
        "attachments": [

        ],
        "custom_fields": [

        ],
        "integration_fields": [

        ],
        "comments_count": 0
      }
    ],
    "initiative": {
      "id": "423077122",
      "name": "Initiative 1",
      "url": "http://company.aha.io/initiatives/PRJ1-S-1",
      "resource": "http://company.aha.io/api/v1/initiatives/PRJ1-S-1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "description": {
        "id": "1007208146",
        "body": "Description of project1_initiative1",
        "created_at": "2019-01-01T00:00:00.000Z",
        "attachments": [

        ]
      },
      "integration_fields": [
        {
          "id": "365436441",
          "name": "key",
          "value": "JRA-987222",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2019-01-01T00:00:00.000Z"
        },
        {
          "id": "213995437",
          "name": "id",
          "value": "9913333",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2019-01-01T00:00:00.000Z"
        }
      ]
    },
    "goals": [
      {
        "id": "602095703",
        "name": "Goal 1",
        "url": "http://company.aha.io/strategic_imperatives/DEMOENT-G-1",
        "resource": "http://company.aha.io/api/v1/goals/DEMOENT-G-1",
        "created_at": "2019-01-01T00:00:00.000Z",
        "description": {
          "id": "258744266",
          "body": "Description of project1_strategic_imperative1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        }
      }
    ],
    "comments_count": 1,
    "score_facts": [
      {
        "id": "728895917",
        "value": 1,
        "name": "Effort"
      },
      {
        "id": "846938137",
        "value": 2,
        "name": "Benefit"
      }
    ],
    "tags": [
      "tag2",
      "tag3"
    ],
    "full_tags": [
      {
        "id": "6825596133166642857",
        "name": "tag2",
        "color": "#52d3e0"
      },
      {
        "id": "6825596133172225344",
        "name": "tag3",
        "color": "#bb52e0"
      }
    ],
    "custom_fields": [
      {
        "key": "expected_completion_date",
        "name": "Expected completion date",
        "value": "2019-01-01",
        "type": "date"
      },
      {
        "key": "equation_specs_field",
        "name": "Equation specs field",
        "value": {
          "values": {
            "123": {
              "value": 10,
              "display_value": "10.0"
            },
            "456": {
              "value": "Foobar",
              "display_value": "Foobar"
            },
            "789": {
              "value": null,
              "display_value": null
            }
          }
        },
        "type": "equation_sheet"
      },
      {
        "key": "negative_scorecard",
        "name": "Negative custom scorecard",
        "value": 31,
        "type": "scorecard",
        "score_facts": [
          {
            "id": "462102328",
            "value": 6,
            "name": "Negative default value"
          }
        ]
      }
    ],
    "feature_links": [
      {
        "link_type": "Depends on",
        "link_type_id": 20,
        "created_at": "2019-01-01T00:00:00.000Z",
        "parent_record": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "child_record": {
          "id": "622562724",
          "reference_num": "PRJ1-2",
          "name": "Another Feature",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-2",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-2",
          "product_id": 131414752
        }
      }
    ],
    "feature_only_original_estimate": null,
    "feature_only_remaining_estimate": null,
    "feature_only_work_done": null
  }
}

PUT /api/v1/features/:id

Update a feature's watchers

Parameters

Name Alias Description
id * Numeric ID, or key of the feature to be edited
name * Name of the feature
workflow_kind type, kind Type of feature
workflow_status status Status of the feature and it must be one of the valid status values for the selected product.
release Numeric ID, or key of the release the feature should be created in.
description Description of the feature and it can include HTML formatting.
created_by created_by_user Email address of user that created the feature.
assigned_to_user Email address of user that is assigned the feature.
tags Tags can be automatically assigned to the new feature. If more than one tag is used then tags should be separated by commas.
original_estimate_text Set the original estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
remaining_estimate_text Set the remaining estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
original_estimate Set the original estimated effort in minutes.
remaining_estimate Set the remaining estimated effort in minutes.
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
master_feature Name or id of master feature 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.

PUT /api/v1/features/PRJ1-1

Example CURL command

curl "https://company.aha.io/api/v1/features/PRJ1-1" -d $'{"feature":{"watchers":[689956296]}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "feature": {
    "watchers": [
      689956296
    ]
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "feature": {
    "id": "1007868956",
    "name": "Feature 1",
    "reference_num": "PRJ1-1",
    "position": 1,
    "score": 3,
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "start_date": "2019-01-01",
    "due_date": "2019-01-01",
    "product_id": 131414752,
    "progress": null,
    "progress_source": "progress_manual",
    "workflow_kind": {
      "id": "98484309",
      "name": "New"
    },
    "workflow_status": {
      "id": "934242751",
      "name": "New",
      "position": 1,
      "complete": false,
      "color": "#dce7c6"
    },
    "description": {
      "id": "793547626",
      "body": "Body of note 1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "attachments": [
        {
          "id": "724655692",
          "download_url": "http://company.lvh.me/attachments/724655692/token/56f7c8a4ee6c66fd6464a0a4d8f1f4e5b13acda44a15426121b3a837f292fafe.download?size=original",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "content_type": "text/plain",
          "file_name": "uploaded_file_name.txt",
          "file_size": 123
        }
      ]
    },
    "attachments": [

    ],
    "integration_fields": [
      {
        "id": "728894778",
        "name": "key",
        "value": "JRA-123",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2019-01-01T00:00:00.000Z"
      },
      {
        "id": "846945422",
        "name": "id",
        "value": "435",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2019-01-01T00:00:00.000Z"
      },
      {
        "id": "92040219",
        "name": "url",
        "value": "https://bigaha.atlassian.net/issues/JRA-123",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2019-01-01T00:00:00.000Z"
      }
    ],
    "url": "http://company.aha.io/features/PRJ1-1",
    "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
    "release": {
      "id": "278327321",
      "reference_num": "PRJ1-R-1",
      "name": "Release 1",
      "start_date": "2019-01-01",
      "release_date": "2019-01-01",
      "parking_lot": false,
      "created_at": "2019-01-01T00:00:00.000Z",
      "product_id": 131414752,
      "integration_fields": [
        {
          "id": "68217473",
          "name": "id",
          "value": "777",
          "integration_id": 204584239,
          "service_name": "jira",
          "created_at": "2019-01-01T00:00:00.000Z"
        }
      ],
      "url": "http://company.aha.io/releases/PRJ1-R-1",
      "resource": "http://company.aha.io/api/v1/releases/PRJ1-R-1",
      "owner": {
        "id": "16338845",
        "name": "John Smith",
        "email": "no-reply@aha.io",
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z"
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2019-01-01T00:00:00.000Z"
      }
    },
    "master_feature": {
      "id": "999605892",
      "reference_num": "PRJ1-E-1",
      "name": "Epic 1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/epics/PRJ1-E-1",
      "resource": "http://company.aha.io/api/v1/master_features/PRJ1-E-1"
    },
    "belongs_to_release_phase": {
      "id": "20526005",
      "name": "Alpha",
      "start_on": "2019-01-01",
      "end_on": "2019-01-01",
      "type": "phase",
      "release_id": 278327321,
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "progress": null,
      "progress_source": "progress_manual",
      "description": {
        "id": "243384959",
        "body": "Description of release phase 1",
        "created_at": "2019-01-01T00:00:00.000Z",
        "attachments": [

        ]
      }
    },
    "created_by_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z"
    },
    "assigned_to_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "default_assignee": false
    },
    "requirements": [
      {
        "id": "483368544",
        "name": "Body of requirement 1",
        "reference_num": "PRJ1-1-1",
        "position": 1,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "release_id": 278327321,
        "workflow_status": {
          "id": "934242751",
          "name": "New",
          "position": 1,
          "complete": false,
          "color": "#dce7c6"
        },
        "url": "http://company.aha.io/requirements/PRJ1-1-1",
        "resource": "http://company.aha.io/api/v1/requirements/PRJ1-1-1",
        "description": {
          "id": "910541534",
          "body": "Body of requirement 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": "16338845",
          "name": "John Smith",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "default_assignee": false
        },
        "created_by_user": {
          "id": "1020675218",
          "name": "Mary Humpty",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z"
        },
        "attachments": [

        ],
        "custom_fields": [
          {
            "key": "expected_completion_date",
            "name": "Expected completion date",
            "value": "2019-01-01",
            "type": "date"
          },
          {
            "key": "requested_by",
            "name": "Requested By",
            "value": "TK",
            "type": "string"
          }
        ],
        "integration_fields": [
          {
            "id": "32487847",
            "name": "key",
            "value": "JRA-987",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2019-01-01T00:00:00.000Z"
          },
          {
            "id": "417785887",
            "name": "id",
            "value": "991",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2019-01-01T00:00:00.000Z"
          }
        ],
        "comments_count": 1
      },
      {
        "id": "96915428",
        "name": "Body of requirement 2",
        "reference_num": "PRJ1-1-2",
        "position": 2,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "release_id": 278327321,
        "workflow_status": {
          "id": "1025247908",
          "name": "Shipped",
          "position": 5,
          "complete": true,
          "color": "#ecdd8f"
        },
        "url": "http://company.aha.io/requirements/PRJ1-1-2",
        "resource": "http://company.aha.io/api/v1/requirements/PRJ1-1-2",
        "description": {
          "id": "6825596140011241021",
          "body": "",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": "16338845",
          "name": "John Smith",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "default_assignee": false
        },
        "created_by_user": {
          "id": "1020675218",
          "name": "Mary Humpty",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z"
        },
        "attachments": [

        ],
        "custom_fields": [

        ],
        "integration_fields": [

        ],
        "comments_count": 0
      },
      {
        "id": "851574643",
        "name": "Body of requirement 3",
        "reference_num": "PRJ1-1-3",
        "position": 3,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "release_id": 278327321,
        "workflow_status": {
          "id": "922838743",
          "name": "Not started",
          "position": 8,
          "complete": false,
          "color": "#dce790"
        },
        "url": "http://company.aha.io/requirements/PRJ1-1-3",
        "resource": "http://company.aha.io/api/v1/requirements/PRJ1-1-3",
        "description": {
          "id": "6825596140289923683",
          "body": "",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": "16338845",
          "name": "John Smith",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "default_assignee": false
        },
        "created_by_user": {
          "id": "1020675218",
          "name": "Mary Humpty",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z"
        },
        "attachments": [

        ],
        "custom_fields": [

        ],
        "integration_fields": [

        ],
        "comments_count": 0
      }
    ],
    "initiative": {
      "id": "423077122",
      "name": "Initiative 1",
      "url": "http://company.aha.io/initiatives/PRJ1-S-1",
      "resource": "http://company.aha.io/api/v1/initiatives/PRJ1-S-1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "description": {
        "id": "1007208146",
        "body": "Description of project1_initiative1",
        "created_at": "2019-01-01T00:00:00.000Z",
        "attachments": [

        ]
      },
      "integration_fields": [
        {
          "id": "365436441",
          "name": "key",
          "value": "JRA-987222",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2019-01-01T00:00:00.000Z"
        },
        {
          "id": "213995437",
          "name": "id",
          "value": "9913333",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2019-01-01T00:00:00.000Z"
        }
      ]
    },
    "goals": [
      {
        "id": "602095703",
        "name": "Goal 1",
        "url": "http://company.aha.io/strategic_imperatives/DEMOENT-G-1",
        "resource": "http://company.aha.io/api/v1/goals/DEMOENT-G-1",
        "created_at": "2019-01-01T00:00:00.000Z",
        "description": {
          "id": "258744266",
          "body": "Description of project1_strategic_imperative1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        }
      }
    ],
    "comments_count": 1,
    "score_facts": [
      {
        "id": "728895917",
        "value": 1,
        "name": "Effort"
      },
      {
        "id": "846938137",
        "value": 2,
        "name": "Benefit"
      }
    ],
    "tags": [
      "Engineering",
      "Infrastructure"
    ],
    "full_tags": [
      {
        "id": 3412727,
        "name": "Engineering",
        "color": "#e09052"
      },
      {
        "id": 775582684,
        "name": "Infrastructure",
        "color": "#7552e0"
      }
    ],
    "custom_fields": [
      {
        "key": "expected_completion_date",
        "name": "Expected completion date",
        "value": "2019-01-01",
        "type": "date"
      },
      {
        "key": "equation_specs_field",
        "name": "Equation specs field",
        "value": {
          "values": {
            "123": {
              "value": 10,
              "display_value": "10.0"
            },
            "456": {
              "value": "Foobar",
              "display_value": "Foobar"
            },
            "789": {
              "value": null,
              "display_value": null
            }
          }
        },
        "type": "equation_sheet"
      },
      {
        "key": "negative_scorecard",
        "name": "Negative custom scorecard",
        "value": 31,
        "type": "scorecard",
        "score_facts": [
          {
            "id": "462102328",
            "value": 6,
            "name": "Negative default value"
          }
        ]
      }
    ],
    "feature_links": [
      {
        "link_type": "Depends on",
        "link_type_id": 20,
        "created_at": "2019-01-01T00:00:00.000Z",
        "parent_record": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "child_record": {
          "id": "622562724",
          "reference_num": "PRJ1-2",
          "name": "Another Feature",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-2",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-2",
          "product_id": 131414752
        }
      }
    ],
    "feature_only_original_estimate": null,
    "feature_only_remaining_estimate": null,
    "feature_only_work_done": null
  }
}

PUT /api/v1/features/:id

Update a feature's goals

Parameters

Name Alias Description
id * Numeric ID, or key of the feature to be edited
name * Name of the feature
workflow_kind type, kind Type of feature
workflow_status status Status of the feature and it must be one of the valid status values for the selected product.
release Numeric ID, or key of the release the feature should be created in.
description Description of the feature and it can include HTML formatting.
created_by created_by_user Email address of user that created the feature.
assigned_to_user Email address of user that is assigned the feature.
tags Tags can be automatically assigned to the new feature. If more than one tag is used then tags should be separated by commas.
original_estimate_text Set the original estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
remaining_estimate_text Set the remaining estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
original_estimate Set the original estimated effort in minutes.
remaining_estimate Set the remaining estimated effort in minutes.
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
master_feature Name or id of master feature 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.

PUT /api/v1/features/PRJ1-1

Example CURL command

curl "https://company.aha.io/api/v1/features/PRJ1-1" -d $'{"feature":{"goals":[602095703]}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "feature": {
    "goals": [
      602095703
    ]
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "feature": {
    "id": "1007868956",
    "name": "Feature 1",
    "reference_num": "PRJ1-1",
    "position": 1,
    "score": 3,
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "start_date": "2019-01-01",
    "due_date": "2019-01-01",
    "product_id": 131414752,
    "progress": null,
    "progress_source": "progress_manual",
    "workflow_kind": {
      "id": "98484309",
      "name": "New"
    },
    "workflow_status": {
      "id": "934242751",
      "name": "New",
      "position": 1,
      "complete": false,
      "color": "#dce7c6"
    },
    "description": {
      "id": "793547626",
      "body": "Body of note 1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "attachments": [
        {
          "id": "724655692",
          "download_url": "http://company.lvh.me/attachments/724655692/token/43f69967b4f47168715b2b68cfd8d7f90f02f7afe4b760c94c1a142ef4e95bee.download?size=original",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "content_type": "text/plain",
          "file_name": "uploaded_file_name.txt",
          "file_size": 123
        }
      ]
    },
    "attachments": [

    ],
    "integration_fields": [
      {
        "id": "728894778",
        "name": "key",
        "value": "JRA-123",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2019-01-01T00:00:00.000Z"
      },
      {
        "id": "846945422",
        "name": "id",
        "value": "435",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2019-01-01T00:00:00.000Z"
      },
      {
        "id": "92040219",
        "name": "url",
        "value": "https://bigaha.atlassian.net/issues/JRA-123",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2019-01-01T00:00:00.000Z"
      }
    ],
    "url": "http://company.aha.io/features/PRJ1-1",
    "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
    "release": {
      "id": "278327321",
      "reference_num": "PRJ1-R-1",
      "name": "Release 1",
      "start_date": "2019-01-01",
      "release_date": "2019-01-01",
      "parking_lot": false,
      "created_at": "2019-01-01T00:00:00.000Z",
      "product_id": 131414752,
      "integration_fields": [
        {
          "id": "68217473",
          "name": "id",
          "value": "777",
          "integration_id": 204584239,
          "service_name": "jira",
          "created_at": "2019-01-01T00:00:00.000Z"
        }
      ],
      "url": "http://company.aha.io/releases/PRJ1-R-1",
      "resource": "http://company.aha.io/api/v1/releases/PRJ1-R-1",
      "owner": {
        "id": "16338845",
        "name": "John Smith",
        "email": "no-reply@aha.io",
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z"
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2019-01-01T00:00:00.000Z"
      }
    },
    "master_feature": {
      "id": "999605892",
      "reference_num": "PRJ1-E-1",
      "name": "Epic 1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/epics/PRJ1-E-1",
      "resource": "http://company.aha.io/api/v1/master_features/PRJ1-E-1"
    },
    "belongs_to_release_phase": {
      "id": "20526005",
      "name": "Alpha",
      "start_on": "2019-01-01",
      "end_on": "2019-01-01",
      "type": "phase",
      "release_id": 278327321,
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "progress": null,
      "progress_source": "progress_manual",
      "description": {
        "id": "243384959",
        "body": "Description of release phase 1",
        "created_at": "2019-01-01T00:00:00.000Z",
        "attachments": [

        ]
      }
    },
    "created_by_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z"
    },
    "assigned_to_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "default_assignee": false
    },
    "requirements": [
      {
        "id": "483368544",
        "name": "Body of requirement 1",
        "reference_num": "PRJ1-1-1",
        "position": 1,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "release_id": 278327321,
        "workflow_status": {
          "id": "934242751",
          "name": "New",
          "position": 1,
          "complete": false,
          "color": "#dce7c6"
        },
        "url": "http://company.aha.io/requirements/PRJ1-1-1",
        "resource": "http://company.aha.io/api/v1/requirements/PRJ1-1-1",
        "description": {
          "id": "910541534",
          "body": "Body of requirement 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": "16338845",
          "name": "John Smith",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "default_assignee": false
        },
        "created_by_user": {
          "id": "1020675218",
          "name": "Mary Humpty",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z"
        },
        "attachments": [

        ],
        "custom_fields": [
          {
            "key": "expected_completion_date",
            "name": "Expected completion date",
            "value": "2019-01-01",
            "type": "date"
          },
          {
            "key": "requested_by",
            "name": "Requested By",
            "value": "TK",
            "type": "string"
          }
        ],
        "integration_fields": [
          {
            "id": "32487847",
            "name": "key",
            "value": "JRA-987",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2019-01-01T00:00:00.000Z"
          },
          {
            "id": "417785887",
            "name": "id",
            "value": "991",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2019-01-01T00:00:00.000Z"
          }
        ],
        "comments_count": 1
      },
      {
        "id": "96915428",
        "name": "Body of requirement 2",
        "reference_num": "PRJ1-1-2",
        "position": 2,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "release_id": 278327321,
        "workflow_status": {
          "id": "1025247908",
          "name": "Shipped",
          "position": 5,
          "complete": true,
          "color": "#ecdd8f"
        },
        "url": "http://company.aha.io/requirements/PRJ1-1-2",
        "resource": "http://company.aha.io/api/v1/requirements/PRJ1-1-2",
        "description": {
          "id": "6825596142499296049",
          "body": "",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": "16338845",
          "name": "John Smith",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "default_assignee": false
        },
        "created_by_user": {
          "id": "1020675218",
          "name": "Mary Humpty",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z"
        },
        "attachments": [

        ],
        "custom_fields": [

        ],
        "integration_fields": [

        ],
        "comments_count": 0
      },
      {
        "id": "851574643",
        "name": "Body of requirement 3",
        "reference_num": "PRJ1-1-3",
        "position": 3,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "release_id": 278327321,
        "workflow_status": {
          "id": "922838743",
          "name": "Not started",
          "position": 8,
          "complete": false,
          "color": "#dce790"
        },
        "url": "http://company.aha.io/requirements/PRJ1-1-3",
        "resource": "http://company.aha.io/api/v1/requirements/PRJ1-1-3",
        "description": {
          "id": "6825596142797266775",
          "body": "",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": "16338845",
          "name": "John Smith",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "default_assignee": false
        },
        "created_by_user": {
          "id": "1020675218",
          "name": "Mary Humpty",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z"
        },
        "attachments": [

        ],
        "custom_fields": [

        ],
        "integration_fields": [

        ],
        "comments_count": 0
      }
    ],
    "initiative": {
      "id": "423077122",
      "name": "Initiative 1",
      "url": "http://company.aha.io/initiatives/PRJ1-S-1",
      "resource": "http://company.aha.io/api/v1/initiatives/PRJ1-S-1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "description": {
        "id": "1007208146",
        "body": "Description of project1_initiative1",
        "created_at": "2019-01-01T00:00:00.000Z",
        "attachments": [

        ]
      },
      "integration_fields": [
        {
          "id": "365436441",
          "name": "key",
          "value": "JRA-987222",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2019-01-01T00:00:00.000Z"
        },
        {
          "id": "213995437",
          "name": "id",
          "value": "9913333",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2019-01-01T00:00:00.000Z"
        }
      ]
    },
    "goals": [
      {
        "id": "602095703",
        "name": "Goal 1",
        "url": "http://company.aha.io/strategic_imperatives/DEMOENT-G-1",
        "resource": "http://company.aha.io/api/v1/goals/DEMOENT-G-1",
        "created_at": "2019-01-01T00:00:00.000Z",
        "description": {
          "id": "258744266",
          "body": "Description of project1_strategic_imperative1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        }
      }
    ],
    "comments_count": 1,
    "score_facts": [
      {
        "id": "728895917",
        "value": 1,
        "name": "Effort"
      },
      {
        "id": "846938137",
        "value": 2,
        "name": "Benefit"
      }
    ],
    "tags": [
      "Engineering",
      "Infrastructure"
    ],
    "full_tags": [
      {
        "id": 3412727,
        "name": "Engineering",
        "color": "#e09052"
      },
      {
        "id": 775582684,
        "name": "Infrastructure",
        "color": "#7552e0"
      }
    ],
    "custom_fields": [
      {
        "key": "expected_completion_date",
        "name": "Expected completion date",
        "value": "2019-01-01",
        "type": "date"
      },
      {
        "key": "equation_specs_field",
        "name": "Equation specs field",
        "value": {
          "values": {
            "123": {
              "value": 10,
              "display_value": "10.0"
            },
            "456": {
              "value": "Foobar",
              "display_value": "Foobar"
            },
            "789": {
              "value": null,
              "display_value": null
            }
          }
        },
        "type": "equation_sheet"
      },
      {
        "key": "negative_scorecard",
        "name": "Negative custom scorecard",
        "value": 31,
        "type": "scorecard",
        "score_facts": [
          {
            "id": "462102328",
            "value": 6,
            "name": "Negative default value"
          }
        ]
      }
    ],
    "feature_links": [
      {
        "link_type": "Depends on",
        "link_type_id": 20,
        "created_at": "2019-01-01T00:00:00.000Z",
        "parent_record": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "child_record": {
          "id": "622562724",
          "reference_num": "PRJ1-2",
          "name": "Another Feature",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-2",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-2",
          "product_id": 131414752
        }
      }
    ],
    "feature_only_original_estimate": null,
    "feature_only_remaining_estimate": null,
    "feature_only_work_done": null
  }
}

PUT /api/v1/features/:id

Update a feature's score

Parameters

Name Alias Description
id * Numeric ID, or key of the feature to be edited
name * Name of the feature
workflow_kind type, kind Type of feature
workflow_status status Status of the feature and it must be one of the valid status values for the selected product.
release Numeric ID, or key of the release the feature should be created in.
description Description of the feature and it can include HTML formatting.
created_by created_by_user Email address of user that created the feature.
assigned_to_user Email address of user that is assigned the feature.
tags Tags can be automatically assigned to the new feature. If more than one tag is used then tags should be separated by commas.
original_estimate_text Set the original estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
remaining_estimate_text Set the remaining estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
original_estimate Set the original estimated effort in minutes.
remaining_estimate Set the remaining estimated effort in minutes.
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
master_feature Name or id of master feature 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.

PUT /api/v1/features/PRJ1-1

Example CURL command

curl "https://company.aha.io/api/v1/features/PRJ1-1" -d $'{"feature":{"score_facts":[{"name":"Benefit","value":4},{"name":"Effort","value":5}]}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "feature": {
    "score_facts": [
      {
        "name": "Benefit",
        "value": 4
      },
      {
        "name": "Effort",
        "value": 5
      }
    ]
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "feature": {
    "id": "1007868956",
    "name": "Feature 1",
    "reference_num": "PRJ1-1",
    "position": 1,
    "score": 9,
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "start_date": "2019-01-01",
    "due_date": "2019-01-01",
    "product_id": 131414752,
    "progress": null,
    "progress_source": "progress_manual",
    "workflow_kind": {
      "id": "98484309",
      "name": "New"
    },
    "workflow_status": {
      "id": "934242751",
      "name": "New",
      "position": 1,
      "complete": false,
      "color": "#dce7c6"
    },
    "description": {
      "id": "793547626",
      "body": "Body of note 1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "attachments": [
        {
          "id": "724655692",
          "download_url": "http://company.lvh.me/attachments/724655692/token/573560c7a6d19f63bef5c2ce59680f2bca6cb14875da8a4ad84522c14d88627e.download?size=original",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "content_type": "text/plain",
          "file_name": "uploaded_file_name.txt",
          "file_size": 123
        }
      ]
    },
    "attachments": [

    ],
    "integration_fields": [
      {
        "id": "728894778",
        "name": "key",
        "value": "JRA-123",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2019-01-01T00:00:00.000Z"
      },
      {
        "id": "846945422",
        "name": "id",
        "value": "435",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2019-01-01T00:00:00.000Z"
      },
      {
        "id": "92040219",
        "name": "url",
        "value": "https://bigaha.atlassian.net/issues/JRA-123",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2019-01-01T00:00:00.000Z"
      }
    ],
    "url": "http://company.aha.io/features/PRJ1-1",
    "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
    "release": {
      "id": "278327321",
      "reference_num": "PRJ1-R-1",
      "name": "Release 1",
      "start_date": "2019-01-01",
      "release_date": "2019-01-01",
      "parking_lot": false,
      "created_at": "2019-01-01T00:00:00.000Z",
      "product_id": 131414752,
      "integration_fields": [
        {
          "id": "68217473",
          "name": "id",
          "value": "777",
          "integration_id": 204584239,
          "service_name": "jira",
          "created_at": "2019-01-01T00:00:00.000Z"
        }
      ],
      "url": "http://company.aha.io/releases/PRJ1-R-1",
      "resource": "http://company.aha.io/api/v1/releases/PRJ1-R-1",
      "owner": {
        "id": "16338845",
        "name": "John Smith",
        "email": "no-reply@aha.io",
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z"
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2019-01-01T00:00:00.000Z"
      }
    },
    "master_feature": {
      "id": "999605892",
      "reference_num": "PRJ1-E-1",
      "name": "Epic 1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/epics/PRJ1-E-1",
      "resource": "http://company.aha.io/api/v1/master_features/PRJ1-E-1"
    },
    "belongs_to_release_phase": {
      "id": "20526005",
      "name": "Alpha",
      "start_on": "2019-01-01",
      "end_on": "2019-01-01",
      "type": "phase",
      "release_id": 278327321,
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "progress": null,
      "progress_source": "progress_manual",
      "description": {
        "id": "243384959",
        "body": "Description of release phase 1",
        "created_at": "2019-01-01T00:00:00.000Z",
        "attachments": [

        ]
      }
    },
    "created_by_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z"
    },
    "assigned_to_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "default_assignee": false
    },
    "requirements": [
      {
        "id": "483368544",
        "name": "Body of requirement 1",
        "reference_num": "PRJ1-1-1",
        "position": 1,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "release_id": 278327321,
        "workflow_status": {
          "id": "934242751",
          "name": "New",
          "position": 1,
          "complete": false,
          "color": "#dce7c6"
        },
        "url": "http://company.aha.io/requirements/PRJ1-1-1",
        "resource": "http://company.aha.io/api/v1/requirements/PRJ1-1-1",
        "description": {
          "id": "910541534",
          "body": "Body of requirement 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": "16338845",
          "name": "John Smith",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "default_assignee": false
        },
        "created_by_user": {
          "id": "1020675218",
          "name": "Mary Humpty",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z"
        },
        "attachments": [

        ],
        "custom_fields": [
          {
            "key": "expected_completion_date",
            "name": "Expected completion date",
            "value": "2019-01-01",
            "type": "date"
          },
          {
            "key": "requested_by",
            "name": "Requested By",
            "value": "TK",
            "type": "string"
          }
        ],
        "integration_fields": [
          {
            "id": "32487847",
            "name": "key",
            "value": "JRA-987",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2019-01-01T00:00:00.000Z"
          },
          {
            "id": "417785887",
            "name": "id",
            "value": "991",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2019-01-01T00:00:00.000Z"
          }
        ],
        "comments_count": 1
      },
      {
        "id": "96915428",
        "name": "Body of requirement 2",
        "reference_num": "PRJ1-1-2",
        "position": 2,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "release_id": 278327321,
        "workflow_status": {
          "id": "1025247908",
          "name": "Shipped",
          "position": 5,
          "complete": true,
          "color": "#ecdd8f"
        },
        "url": "http://company.aha.io/requirements/PRJ1-1-2",
        "resource": "http://company.aha.io/api/v1/requirements/PRJ1-1-2",
        "description": {
          "id": "6825596145246205715",
          "body": "",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": "16338845",
          "name": "John Smith",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "default_assignee": false
        },
        "created_by_user": {
          "id": "1020675218",
          "name": "Mary Humpty",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z"
        },
        "attachments": [

        ],
        "custom_fields": [

        ],
        "integration_fields": [

        ],
        "comments_count": 0
      },
      {
        "id": "851574643",
        "name": "Body of requirement 3",
        "reference_num": "PRJ1-1-3",
        "position": 3,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "release_id": 278327321,
        "workflow_status": {
          "id": "922838743",
          "name": "Not started",
          "position": 8,
          "complete": false,
          "color": "#dce790"
        },
        "url": "http://company.aha.io/requirements/PRJ1-1-3",
        "resource": "http://company.aha.io/api/v1/requirements/PRJ1-1-3",
        "description": {
          "id": "6825596145580246171",
          "body": "",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": "16338845",
          "name": "John Smith",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "default_assignee": false
        },
        "created_by_user": {
          "id": "1020675218",
          "name": "Mary Humpty",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z"
        },
        "attachments": [

        ],
        "custom_fields": [

        ],
        "integration_fields": [

        ],
        "comments_count": 0
      }
    ],
    "initiative": {
      "id": "423077122",
      "name": "Initiative 1",
      "url": "http://company.aha.io/initiatives/PRJ1-S-1",
      "resource": "http://company.aha.io/api/v1/initiatives/PRJ1-S-1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "description": {
        "id": "1007208146",
        "body": "Description of project1_initiative1",
        "created_at": "2019-01-01T00:00:00.000Z",
        "attachments": [

        ]
      },
      "integration_fields": [
        {
          "id": "365436441",
          "name": "key",
          "value": "JRA-987222",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2019-01-01T00:00:00.000Z"
        },
        {
          "id": "213995437",
          "name": "id",
          "value": "9913333",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2019-01-01T00:00:00.000Z"
        }
      ]
    },
    "goals": [
      {
        "id": "602095703",
        "name": "Goal 1",
        "url": "http://company.aha.io/strategic_imperatives/DEMOENT-G-1",
        "resource": "http://company.aha.io/api/v1/goals/DEMOENT-G-1",
        "created_at": "2019-01-01T00:00:00.000Z",
        "description": {
          "id": "258744266",
          "body": "Description of project1_strategic_imperative1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        }
      }
    ],
    "comments_count": 1,
    "score_facts": [
      {
        "id": "728895917",
        "value": 5,
        "name": "Effort"
      },
      {
        "id": "846938137",
        "value": 4,
        "name": "Benefit"
      }
    ],
    "tags": [
      "Engineering",
      "Infrastructure"
    ],
    "full_tags": [
      {
        "id": 3412727,
        "name": "Engineering",
        "color": "#e09052"
      },
      {
        "id": 775582684,
        "name": "Infrastructure",
        "color": "#7552e0"
      }
    ],
    "custom_fields": [
      {
        "key": "expected_completion_date",
        "name": "Expected completion date",
        "value": "2019-01-01",
        "type": "date"
      },
      {
        "key": "equation_specs_field",
        "name": "Equation specs field",
        "value": {
          "values": {
            "123": {
              "value": 10,
              "display_value": "10.0"
            },
            "456": {
              "value": "Foobar",
              "display_value": "Foobar"
            },
            "789": {
              "value": null,
              "display_value": null
            }
          }
        },
        "type": "equation_sheet"
      },
      {
        "key": "negative_scorecard",
        "name": "Negative custom scorecard",
        "value": 31,
        "type": "scorecard",
        "score_facts": [
          {
            "id": "462102328",
            "value": 6,
            "name": "Negative default value"
          }
        ]
      }
    ],
    "feature_links": [
      {
        "link_type": "Depends on",
        "link_type_id": 20,
        "created_at": "2019-01-01T00:00:00.000Z",
        "parent_record": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "child_record": {
          "id": "622562724",
          "reference_num": "PRJ1-2",
          "name": "Another Feature",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-2",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-2",
          "product_id": 131414752
        }
      }
    ],
    "feature_only_original_estimate": null,
    "feature_only_remaining_estimate": null,
    "feature_only_work_done": null
  }
}

PUT /api/v1/features/:id

Add a feature to a master feature

Parameters

Name Alias Description
id * Numeric ID, or key of the feature to be edited
name * Name of the feature
workflow_kind type, kind Type of feature
workflow_status status Status of the feature and it must be one of the valid status values for the selected product.
release Numeric ID, or key of the release the feature should be created in.
description Description of the feature and it can include HTML formatting.
created_by created_by_user Email address of user that created the feature.
assigned_to_user Email address of user that is assigned the feature.
tags Tags can be automatically assigned to the new feature. If more than one tag is used then tags should be separated by commas.
original_estimate_text Set the original estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
remaining_estimate_text Set the remaining estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
original_estimate Set the original estimated effort in minutes.
remaining_estimate Set the remaining estimated effort in minutes.
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
master_feature Name or id of master feature 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.

PUT /api/v1/features/PRJ1-1

Example CURL command

curl "https://company.aha.io/api/v1/features/PRJ1-1" -d $'{"feature":{"master_feature":"PRJ1-E-1"}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "feature": {
    "master_feature": "PRJ1-E-1"
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "feature": {
    "id": "1007868956",
    "name": "Feature 1",
    "reference_num": "PRJ1-1",
    "position": 1,
    "score": 3,
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "start_date": "2019-01-01",
    "due_date": "2019-01-01",
    "product_id": 131414752,
    "progress": null,
    "progress_source": "progress_manual",
    "workflow_kind": {
      "id": "98484309",
      "name": "New"
    },
    "workflow_status": {
      "id": "934242751",
      "name": "New",
      "position": 1,
      "complete": false,
      "color": "#dce7c6"
    },
    "description": {
      "id": "793547626",
      "body": "Body of note 1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "attachments": [
        {
          "id": "724655692",
          "download_url": "http://company.lvh.me/attachments/724655692/token/946abf032747a08efab9cf7b1afaa22fc98d55f790ba4680c01703d7dcbf2a1a.download?size=original",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "content_type": "text/plain",
          "file_name": "uploaded_file_name.txt",
          "file_size": 123
        }
      ]
    },
    "attachments": [

    ],
    "integration_fields": [
      {
        "id": "728894778",
        "name": "key",
        "value": "JRA-123",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2019-01-01T00:00:00.000Z"
      },
      {
        "id": "846945422",
        "name": "id",
        "value": "435",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2019-01-01T00:00:00.000Z"
      },
      {
        "id": "92040219",
        "name": "url",
        "value": "https://bigaha.atlassian.net/issues/JRA-123",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2019-01-01T00:00:00.000Z"
      }
    ],
    "url": "http://company.aha.io/features/PRJ1-1",
    "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
    "release": {
      "id": "278327321",
      "reference_num": "PRJ1-R-1",
      "name": "Release 1",
      "start_date": "2019-01-01",
      "release_date": "2019-01-01",
      "parking_lot": false,
      "created_at": "2019-01-01T00:00:00.000Z",
      "product_id": 131414752,
      "integration_fields": [
        {
          "id": "68217473",
          "name": "id",
          "value": "777",
          "integration_id": 204584239,
          "service_name": "jira",
          "created_at": "2019-01-01T00:00:00.000Z"
        }
      ],
      "url": "http://company.aha.io/releases/PRJ1-R-1",
      "resource": "http://company.aha.io/api/v1/releases/PRJ1-R-1",
      "owner": {
        "id": "16338845",
        "name": "John Smith",
        "email": "no-reply@aha.io",
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z"
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2019-01-01T00:00:00.000Z"
      }
    },
    "master_feature": {
      "id": "999605892",
      "reference_num": "PRJ1-E-1",
      "name": "Epic 1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/epics/PRJ1-E-1",
      "resource": "http://company.aha.io/api/v1/master_features/PRJ1-E-1"
    },
    "belongs_to_release_phase": {
      "id": "20526005",
      "name": "Alpha",
      "start_on": "2019-01-01",
      "end_on": "2019-01-01",
      "type": "phase",
      "release_id": 278327321,
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "progress": null,
      "progress_source": "progress_manual",
      "description": {
        "id": "243384959",
        "body": "Description of release phase 1",
        "created_at": "2019-01-01T00:00:00.000Z",
        "attachments": [

        ]
      }
    },
    "created_by_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z"
    },
    "assigned_to_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "default_assignee": false
    },
    "requirements": [
      {
        "id": "483368544",
        "name": "Body of requirement 1",
        "reference_num": "PRJ1-1-1",
        "position": 1,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "release_id": 278327321,
        "workflow_status": {
          "id": "934242751",
          "name": "New",
          "position": 1,
          "complete": false,
          "color": "#dce7c6"
        },
        "url": "http://company.aha.io/requirements/PRJ1-1-1",
        "resource": "http://company.aha.io/api/v1/requirements/PRJ1-1-1",
        "description": {
          "id": "910541534",
          "body": "Body of requirement 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": "16338845",
          "name": "John Smith",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "default_assignee": false
        },
        "created_by_user": {
          "id": "1020675218",
          "name": "Mary Humpty",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z"
        },
        "attachments": [

        ],
        "custom_fields": [
          {
            "key": "expected_completion_date",
            "name": "Expected completion date",
            "value": "2019-01-01",
            "type": "date"
          },
          {
            "key": "requested_by",
            "name": "Requested By",
            "value": "TK",
            "type": "string"
          }
        ],
        "integration_fields": [
          {
            "id": "32487847",
            "name": "key",
            "value": "JRA-987",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2019-01-01T00:00:00.000Z"
          },
          {
            "id": "417785887",
            "name": "id",
            "value": "991",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2019-01-01T00:00:00.000Z"
          }
        ],
        "comments_count": 1
      },
      {
        "id": "96915428",
        "name": "Body of requirement 2",
        "reference_num": "PRJ1-1-2",
        "position": 2,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "release_id": 278327321,
        "workflow_status": {
          "id": "1025247908",
          "name": "Shipped",
          "position": 5,
          "complete": true,
          "color": "#ecdd8f"
        },
        "url": "http://company.aha.io/requirements/PRJ1-1-2",
        "resource": "http://company.aha.io/api/v1/requirements/PRJ1-1-2",
        "description": {
          "id": "6825596147572891641",
          "body": "",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": "16338845",
          "name": "John Smith",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "default_assignee": false
        },
        "created_by_user": {
          "id": "1020675218",
          "name": "Mary Humpty",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z"
        },
        "attachments": [

        ],
        "custom_fields": [

        ],
        "integration_fields": [

        ],
        "comments_count": 0
      },
      {
        "id": "851574643",
        "name": "Body of requirement 3",
        "reference_num": "PRJ1-1-3",
        "position": 3,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "release_id": 278327321,
        "workflow_status": {
          "id": "922838743",
          "name": "Not started",
          "position": 8,
          "complete": false,
          "color": "#dce790"
        },
        "url": "http://company.aha.io/requirements/PRJ1-1-3",
        "resource": "http://company.aha.io/api/v1/requirements/PRJ1-1-3",
        "description": {
          "id": "6825596148031030830",
          "body": "",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": "16338845",
          "name": "John Smith",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "default_assignee": false
        },
        "created_by_user": {
          "id": "1020675218",
          "name": "Mary Humpty",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z"
        },
        "attachments": [

        ],
        "custom_fields": [

        ],
        "integration_fields": [

        ],
        "comments_count": 0
      }
    ],
    "initiative": {
      "id": "423077122",
      "name": "Initiative 1",
      "url": "http://company.aha.io/initiatives/PRJ1-S-1",
      "resource": "http://company.aha.io/api/v1/initiatives/PRJ1-S-1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "description": {
        "id": "1007208146",
        "body": "Description of project1_initiative1",
        "created_at": "2019-01-01T00:00:00.000Z",
        "attachments": [

        ]
      },
      "integration_fields": [
        {
          "id": "365436441",
          "name": "key",
          "value": "JRA-987222",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2019-01-01T00:00:00.000Z"
        },
        {
          "id": "213995437",
          "name": "id",
          "value": "9913333",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2019-01-01T00:00:00.000Z"
        }
      ]
    },
    "goals": [
      {
        "id": "602095703",
        "name": "Goal 1",
        "url": "http://company.aha.io/strategic_imperatives/DEMOENT-G-1",
        "resource": "http://company.aha.io/api/v1/goals/DEMOENT-G-1",
        "created_at": "2019-01-01T00:00:00.000Z",
        "description": {
          "id": "258744266",
          "body": "Description of project1_strategic_imperative1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        }
      }
    ],
    "comments_count": 1,
    "score_facts": [
      {
        "id": "728895917",
        "value": 1,
        "name": "Effort"
      },
      {
        "id": "846938137",
        "value": 2,
        "name": "Benefit"
      }
    ],
    "tags": [
      "Engineering",
      "Infrastructure"
    ],
    "full_tags": [
      {
        "id": 3412727,
        "name": "Engineering",
        "color": "#e09052"
      },
      {
        "id": 775582684,
        "name": "Infrastructure",
        "color": "#7552e0"
      }
    ],
    "custom_fields": [
      {
        "key": "expected_completion_date",
        "name": "Expected completion date",
        "value": "2019-01-01",
        "type": "date"
      },
      {
        "key": "equation_specs_field",
        "name": "Equation specs field",
        "value": {
          "values": {
            "123": {
              "value": 10,
              "display_value": "10.0"
            },
            "456": {
              "value": "Foobar",
              "display_value": "Foobar"
            },
            "789": {
              "value": null,
              "display_value": null
            }
          }
        },
        "type": "equation_sheet"
      },
      {
        "key": "negative_scorecard",
        "name": "Negative custom scorecard",
        "value": 31,
        "type": "scorecard",
        "score_facts": [
          {
            "id": "462102328",
            "value": 6,
            "name": "Negative default value"
          }
        ]
      }
    ],
    "feature_links": [
      {
        "link_type": "Depends on",
        "link_type_id": 20,
        "created_at": "2019-01-01T00:00:00.000Z",
        "parent_record": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "child_record": {
          "id": "622562724",
          "reference_num": "PRJ1-2",
          "name": "Another Feature",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-2",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-2",
          "product_id": 131414752
        }
      }
    ],
    "feature_only_original_estimate": null,
    "feature_only_remaining_estimate": null,
    "feature_only_work_done": null
  }
}

PUT /api/v1/features/:id

Move a feature to a different release

Parameters

Name Alias Description
id * Numeric ID, or key of the feature to be edited
name * Name of the feature
workflow_kind type, kind Type of feature
workflow_status status Status of the feature and it must be one of the valid status values for the selected product.
release Numeric ID, or key of the release the feature should be created in.
description Description of the feature and it can include HTML formatting.
created_by created_by_user Email address of user that created the feature.
assigned_to_user Email address of user that is assigned the feature.
tags Tags can be automatically assigned to the new feature. If more than one tag is used then tags should be separated by commas.
original_estimate_text Set the original estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
remaining_estimate_text Set the remaining estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
original_estimate Set the original estimated effort in minutes.
remaining_estimate Set the remaining estimated effort in minutes.
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
master_feature Name or id of master feature 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.

PUT /api/v1/features/PRJ1-1

Example CURL command

curl "https://company.aha.io/api/v1/features/PRJ1-1" -d $'{"feature":{"release":"PRJ1-R-2"}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "feature": {
    "release": "PRJ1-R-2"
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "feature": {
    "id": "1007868956",
    "name": "Feature 1",
    "reference_num": "PRJ1-1",
    "position": 1,
    "score": 3,
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "start_date": "2019-01-01",
    "due_date": "2019-01-01",
    "product_id": 131414752,
    "progress": null,
    "progress_source": "progress_manual",
    "workflow_kind": {
      "id": "98484309",
      "name": "New"
    },
    "workflow_status": {
      "id": "934242751",
      "name": "New",
      "position": 1,
      "complete": false,
      "color": "#dce7c6"
    },
    "description": {
      "id": "793547626",
      "body": "Body of note 1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "attachments": [
        {
          "id": "724655692",
          "download_url": "http://company.lvh.me/attachments/724655692/token/22af8f2443ba527f9dc3ab5b330990b86d0e9ea74afe9f535f705a832f9e0766.download?size=original",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "content_type": "text/plain",
          "file_name": "uploaded_file_name.txt",
          "file_size": 123
        }
      ]
    },
    "attachments": [

    ],
    "integration_fields": [
      {
        "id": "728894778",
        "name": "key",
        "value": "JRA-123",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2019-01-01T00:00:00.000Z"
      },
      {
        "id": "846945422",
        "name": "id",
        "value": "435",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2019-01-01T00:00:00.000Z"
      },
      {
        "id": "92040219",
        "name": "url",
        "value": "https://bigaha.atlassian.net/issues/JRA-123",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2019-01-01T00:00:00.000Z"
      }
    ],
    "url": "http://company.aha.io/features/PRJ1-1",
    "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
    "release": {
      "id": "161456549",
      "reference_num": "PRJ1-R-2",
      "name": "Release 2",
      "start_date": "2019-01-01",
      "release_date": "2019-01-01",
      "parking_lot": false,
      "created_at": "2019-01-01T00:00:00.000Z",
      "product_id": 131414752,
      "integration_fields": [

      ],
      "url": "http://company.aha.io/releases/PRJ1-R-2",
      "resource": "http://company.aha.io/api/v1/releases/PRJ1-R-2",
      "owner": {
        "id": "16338845",
        "name": "John Smith",
        "email": "no-reply@aha.io",
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z"
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2019-01-01T00:00:00.000Z"
      }
    },
    "master_feature": {
      "id": "999605892",
      "reference_num": "PRJ1-E-1",
      "name": "Epic 1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/epics/PRJ1-E-1",
      "resource": "http://company.aha.io/api/v1/master_features/PRJ1-E-1"
    },
    "created_by_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z"
    },
    "assigned_to_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "default_assignee": false
    },
    "requirements": [
      {
        "id": "483368544",
        "name": "Body of requirement 1",
        "reference_num": "PRJ1-1-1",
        "position": 1,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "release_id": 161456549,
        "workflow_status": {
          "id": "934242751",
          "name": "New",
          "position": 1,
          "complete": false,
          "color": "#dce7c6"
        },
        "url": "http://company.aha.io/requirements/PRJ1-1-1",
        "resource": "http://company.aha.io/api/v1/requirements/PRJ1-1-1",
        "description": {
          "id": "910541534",
          "body": "Body of requirement 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": "16338845",
          "name": "John Smith",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "default_assignee": false
        },
        "created_by_user": {
          "id": "1020675218",
          "name": "Mary Humpty",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z"
        },
        "attachments": [

        ],
        "custom_fields": [
          {
            "key": "expected_completion_date",
            "name": "Expected completion date",
            "value": "2019-01-01",
            "type": "date"
          },
          {
            "key": "requested_by",
            "name": "Requested By",
            "value": "TK",
            "type": "string"
          }
        ],
        "integration_fields": [
          {
            "id": "32487847",
            "name": "key",
            "value": "JRA-987",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2019-01-01T00:00:00.000Z"
          },
          {
            "id": "417785887",
            "name": "id",
            "value": "991",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2019-01-01T00:00:00.000Z"
          }
        ],
        "comments_count": 1
      },
      {
        "id": "96915428",
        "name": "Body of requirement 2",
        "reference_num": "PRJ1-1-2",
        "position": 2,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "release_id": 161456549,
        "workflow_status": {
          "id": "1025247908",
          "name": "Shipped",
          "position": 5,
          "complete": true,
          "color": "#ecdd8f"
        },
        "url": "http://company.aha.io/requirements/PRJ1-1-2",
        "resource": "http://company.aha.io/api/v1/requirements/PRJ1-1-2",
        "description": {
          "id": "6825596150363803729",
          "body": "",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": "16338845",
          "name": "John Smith",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "default_assignee": false
        },
        "created_by_user": {
          "id": "1020675218",
          "name": "Mary Humpty",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z"
        },
        "attachments": [

        ],
        "custom_fields": [

        ],
        "integration_fields": [

        ],
        "comments_count": 0
      },
      {
        "id": "851574643",
        "name": "Body of requirement 3",
        "reference_num": "PRJ1-1-3",
        "position": 3,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "release_id": 161456549,
        "workflow_status": {
          "id": "922838743",
          "name": "Not started",
          "position": 8,
          "complete": false,
          "color": "#dce790"
        },
        "url": "http://company.aha.io/requirements/PRJ1-1-3",
        "resource": "http://company.aha.io/api/v1/requirements/PRJ1-1-3",
        "description": {
          "id": "6825596150672513971",
          "body": "",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": "16338845",
          "name": "John Smith",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "default_assignee": false
        },
        "created_by_user": {
          "id": "1020675218",
          "name": "Mary Humpty",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z"
        },
        "attachments": [

        ],
        "custom_fields": [

        ],
        "integration_fields": [

        ],
        "comments_count": 0
      }
    ],
    "initiative": {
      "id": "423077122",
      "name": "Initiative 1",
      "url": "http://company.aha.io/initiatives/PRJ1-S-1",
      "resource": "http://company.aha.io/api/v1/initiatives/PRJ1-S-1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "description": {
        "id": "1007208146",
        "body": "Description of project1_initiative1",
        "created_at": "2019-01-01T00:00:00.000Z",
        "attachments": [

        ]
      },
      "integration_fields": [
        {
          "id": "365436441",
          "name": "key",
          "value": "JRA-987222",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2019-01-01T00:00:00.000Z"
        },
        {
          "id": "213995437",
          "name": "id",
          "value": "9913333",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2019-01-01T00:00:00.000Z"
        }
      ]
    },
    "goals": [
      {
        "id": "602095703",
        "name": "Goal 1",
        "url": "http://company.aha.io/strategic_imperatives/DEMOENT-G-1",
        "resource": "http://company.aha.io/api/v1/goals/DEMOENT-G-1",
        "created_at": "2019-01-01T00:00:00.000Z",
        "description": {
          "id": "258744266",
          "body": "Description of project1_strategic_imperative1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        }
      }
    ],
    "comments_count": 1,
    "score_facts": [
      {
        "id": "728895917",
        "value": 1,
        "name": "Effort"
      },
      {
        "id": "846938137",
        "value": 2,
        "name": "Benefit"
      }
    ],
    "tags": [
      "Engineering",
      "Infrastructure"
    ],
    "full_tags": [
      {
        "id": 3412727,
        "name": "Engineering",
        "color": "#e09052"
      },
      {
        "id": 775582684,
        "name": "Infrastructure",
        "color": "#7552e0"
      }
    ],
    "custom_fields": [
      {
        "key": "expected_completion_date",
        "name": "Expected completion date",
        "value": "2019-01-01",
        "type": "date"
      },
      {
        "key": "equation_specs_field",
        "name": "Equation specs field",
        "value": {
          "values": {
            "123": {
              "value": 10,
              "display_value": "10.0"
            },
            "456": {
              "value": "Foobar",
              "display_value": "Foobar"
            },
            "789": {
              "value": null,
              "display_value": null
            }
          }
        },
        "type": "equation_sheet"
      },
      {
        "key": "negative_scorecard",
        "name": "Negative custom scorecard",
        "value": 31,
        "type": "scorecard",
        "score_facts": [
          {
            "id": "462102328",
            "value": 6,
            "name": "Negative default value"
          }
        ]
      }
    ],
    "feature_links": [
      {
        "link_type": "Depends on",
        "link_type_id": 20,
        "created_at": "2019-01-01T00:00:00.000Z",
        "parent_record": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "child_record": {
          "id": "622562724",
          "reference_num": "PRJ1-2",
          "name": "Another Feature",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-2",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-2",
          "product_id": 131414752
        }
      }
    ],
    "feature_only_original_estimate": null,
    "feature_only_remaining_estimate": null,
    "feature_only_work_done": null
  }
}

PUT /api/v1/features/:id

Update a feature's progress source

Parameters

Name Alias Description
id * Numeric ID, or key of the feature to be edited
name * Name of the feature
workflow_kind type, kind Type of feature
workflow_status status Status of the feature and it must be one of the valid status values for the selected product.
release Numeric ID, or key of the release the feature should be created in.
description Description of the feature and it can include HTML formatting.
created_by created_by_user Email address of user that created the feature.
assigned_to_user Email address of user that is assigned the feature.
tags Tags can be automatically assigned to the new feature. If more than one tag is used then tags should be separated by commas.
original_estimate_text Set the original estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
remaining_estimate_text Set the remaining estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
original_estimate Set the original estimated effort in minutes.
remaining_estimate Set the remaining estimated effort in minutes.
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
master_feature Name or id of master feature 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.

PUT /api/v1/features/PRJ1-1

Example CURL command

curl "https://company.aha.io/api/v1/features/PRJ1-1" -d $'{"feature":{"progress_source":"progress_from_requirements"}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "feature": {
    "progress_source": "progress_from_requirements"
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "feature": {
    "id": "1007868956",
    "name": "Feature 1",
    "reference_num": "PRJ1-1",
    "position": 1,
    "score": 3,
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "start_date": "2019-01-01",
    "due_date": "2019-01-01",
    "product_id": 131414752,
    "progress": 33,
    "progress_source": "progress_from_requirements",
    "workflow_kind": {
      "id": "98484309",
      "name": "New"
    },
    "workflow_status": {
      "id": "934242751",
      "name": "New",
      "position": 1,
      "complete": false,
      "color": "#dce7c6"
    },
    "description": {
      "id": "793547626",
      "body": "Body of note 1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "attachments": [
        {
          "id": "724655692",
          "download_url": "http://company.lvh.me/attachments/724655692/token/47c2e9059e15d12dd5bd2ad48429b916d36da468326984ced6dd5354ac02ba5d.download?size=original",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "content_type": "text/plain",
          "file_name": "uploaded_file_name.txt",
          "file_size": 123
        }
      ]
    },
    "attachments": [

    ],
    "integration_fields": [
      {
        "id": "728894778",
        "name": "key",
        "value": "JRA-123",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2019-01-01T00:00:00.000Z"
      },
      {
        "id": "846945422",
        "name": "id",
        "value": "435",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2019-01-01T00:00:00.000Z"
      },
      {
        "id": "92040219",
        "name": "url",
        "value": "https://bigaha.atlassian.net/issues/JRA-123",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2019-01-01T00:00:00.000Z"
      }
    ],
    "url": "http://company.aha.io/features/PRJ1-1",
    "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
    "release": {
      "id": "278327321",
      "reference_num": "PRJ1-R-1",
      "name": "Release 1",
      "start_date": "2019-01-01",
      "release_date": "2019-01-01",
      "parking_lot": false,
      "created_at": "2019-01-01T00:00:00.000Z",
      "product_id": 131414752,
      "integration_fields": [
        {
          "id": "68217473",
          "name": "id",
          "value": "777",
          "integration_id": 204584239,
          "service_name": "jira",
          "created_at": "2019-01-01T00:00:00.000Z"
        }
      ],
      "url": "http://company.aha.io/releases/PRJ1-R-1",
      "resource": "http://company.aha.io/api/v1/releases/PRJ1-R-1",
      "owner": {
        "id": "16338845",
        "name": "John Smith",
        "email": "no-reply@aha.io",
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z"
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2019-01-01T00:00:00.000Z"
      }
    },
    "master_feature": {
      "id": "999605892",
      "reference_num": "PRJ1-E-1",
      "name": "Epic 1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/epics/PRJ1-E-1",
      "resource": "http://company.aha.io/api/v1/master_features/PRJ1-E-1"
    },
    "belongs_to_release_phase": {
      "id": "20526005",
      "name": "Alpha",
      "start_on": "2019-01-01",
      "end_on": "2019-01-01",
      "type": "phase",
      "release_id": 278327321,
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "progress": null,
      "progress_source": "progress_manual",
      "description": {
        "id": "243384959",
        "body": "Description of release phase 1",
        "created_at": "2019-01-01T00:00:00.000Z",
        "attachments": [

        ]
      }
    },
    "created_by_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z"
    },
    "assigned_to_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "default_assignee": false
    },
    "requirements": [
      {
        "id": "483368544",
        "name": "Body of requirement 1",
        "reference_num": "PRJ1-1-1",
        "position": 1,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "release_id": 278327321,
        "workflow_status": {
          "id": "934242751",
          "name": "New",
          "position": 1,
          "complete": false,
          "color": "#dce7c6"
        },
        "url": "http://company.aha.io/requirements/PRJ1-1-1",
        "resource": "http://company.aha.io/api/v1/requirements/PRJ1-1-1",
        "description": {
          "id": "910541534",
          "body": "Body of requirement 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": "16338845",
          "name": "John Smith",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "default_assignee": false
        },
        "created_by_user": {
          "id": "1020675218",
          "name": "Mary Humpty",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z"
        },
        "attachments": [

        ],
        "custom_fields": [
          {
            "key": "expected_completion_date",
            "name": "Expected completion date",
            "value": "2019-01-01",
            "type": "date"
          },
          {
            "key": "requested_by",
            "name": "Requested By",
            "value": "TK",
            "type": "string"
          }
        ],
        "integration_fields": [
          {
            "id": "32487847",
            "name": "key",
            "value": "JRA-987",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2019-01-01T00:00:00.000Z"
          },
          {
            "id": "417785887",
            "name": "id",
            "value": "991",
            "integration_id": 342659513,
            "service_name": "jira",
            "created_at": "2019-01-01T00:00:00.000Z"
          }
        ],
        "comments_count": 1
      },
      {
        "id": "96915428",
        "name": "Body of requirement 2",
        "reference_num": "PRJ1-1-2",
        "position": 2,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "release_id": 278327321,
        "workflow_status": {
          "id": "1025247908",
          "name": "Shipped",
          "position": 5,
          "complete": true,
          "color": "#ecdd8f"
        },
        "url": "http://company.aha.io/requirements/PRJ1-1-2",
        "resource": "http://company.aha.io/api/v1/requirements/PRJ1-1-2",
        "description": {
          "id": "6825596153845011231",
          "body": "",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": "16338845",
          "name": "John Smith",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "default_assignee": false
        },
        "created_by_user": {
          "id": "1020675218",
          "name": "Mary Humpty",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z"
        },
        "attachments": [

        ],
        "custom_fields": [

        ],
        "integration_fields": [

        ],
        "comments_count": 0
      },
      {
        "id": "851574643",
        "name": "Body of requirement 3",
        "reference_num": "PRJ1-1-3",
        "position": 3,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "release_id": 278327321,
        "workflow_status": {
          "id": "922838743",
          "name": "Not started",
          "position": 8,
          "complete": false,
          "color": "#dce790"
        },
        "url": "http://company.aha.io/requirements/PRJ1-1-3",
        "resource": "http://company.aha.io/api/v1/requirements/PRJ1-1-3",
        "description": {
          "id": "6825596154336932540",
          "body": "",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": "16338845",
          "name": "John Smith",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "default_assignee": false
        },
        "created_by_user": {
          "id": "1020675218",
          "name": "Mary Humpty",
          "email": "no-reply@aha.io",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z"
        },
        "attachments": [

        ],
        "custom_fields": [

        ],
        "integration_fields": [

        ],
        "comments_count": 0
      }
    ],
    "initiative": {
      "id": "423077122",
      "name": "Initiative 1",
      "url": "http://company.aha.io/initiatives/PRJ1-S-1",
      "resource": "http://company.aha.io/api/v1/initiatives/PRJ1-S-1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "description": {
        "id": "1007208146",
        "body": "Description of project1_initiative1",
        "created_at": "2019-01-01T00:00:00.000Z",
        "attachments": [

        ]
      },
      "integration_fields": [
        {
          "id": "365436441",
          "name": "key",
          "value": "JRA-987222",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2019-01-01T00:00:00.000Z"
        },
        {
          "id": "213995437",
          "name": "id",
          "value": "9913333",
          "integration_id": 342659513,
          "service_name": "jira",
          "created_at": "2019-01-01T00:00:00.000Z"
        }
      ]
    },
    "goals": [
      {
        "id": "602095703",
        "name": "Goal 1",
        "url": "http://company.aha.io/strategic_imperatives/DEMOENT-G-1",
        "resource": "http://company.aha.io/api/v1/goals/DEMOENT-G-1",
        "created_at": "2019-01-01T00:00:00.000Z",
        "description": {
          "id": "258744266",
          "body": "Description of project1_strategic_imperative1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        }
      }
    ],
    "comments_count": 1,
    "score_facts": [
      {
        "id": "728895917",
        "value": 1,
        "name": "Effort"
      },
      {
        "id": "846938137",
        "value": 2,
        "name": "Benefit"
      }
    ],
    "tags": [
      "Engineering",
      "Infrastructure"
    ],
    "full_tags": [
      {
        "id": 3412727,
        "name": "Engineering",
        "color": "#e09052"
      },
      {
        "id": 775582684,
        "name": "Infrastructure",
        "color": "#7552e0"
      }
    ],
    "custom_fields": [
      {
        "key": "expected_completion_date",
        "name": "Expected completion date",
        "value": "2019-01-01",
        "type": "date"
      },
      {
        "key": "equation_specs_field",
        "name": "Equation specs field",
        "value": {
          "values": {
            "123": {
              "value": 10,
              "display_value": "10.0"
            },
            "456": {
              "value": "Foobar",
              "display_value": "Foobar"
            },
            "789": {
              "value": null,
              "display_value": null
            }
          }
        },
        "type": "equation_sheet"
      },
      {
        "key": "negative_scorecard",
        "name": "Negative custom scorecard",
        "value": 31,
        "type": "scorecard",
        "score_facts": [
          {
            "id": "462102328",
            "value": 6,
            "name": "Negative default value"
          }
        ]
      }
    ],
    "feature_links": [
      {
        "link_type": "Depends on",
        "link_type_id": 20,
        "created_at": "2019-01-01T00:00:00.000Z",
        "parent_record": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "child_record": {
          "id": "622562724",
          "reference_num": "PRJ1-2",
          "name": "Another Feature",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-2",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-2",
          "product_id": 131414752
        }
      }
    ],
    "feature_only_original_estimate": null,
    "feature_only_remaining_estimate": null,
    "feature_only_work_done": null
  }
}

PUT /api/v1/features/:id

Update a feature's progress

Parameters

Name Alias Description
id * Numeric ID, or key of the feature to be edited
name * Name of the feature
workflow_kind type, kind Type of feature
workflow_status status Status of the feature and it must be one of the valid status values for the selected product.
release Numeric ID, or key of the release the feature should be created in.
description Description of the feature and it can include HTML formatting.
created_by created_by_user Email address of user that created the feature.
assigned_to_user Email address of user that is assigned the feature.
tags Tags can be automatically assigned to the new feature. If more than one tag is used then tags should be separated by commas.
original_estimate_text Set the original estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
remaining_estimate_text Set the remaining estimated effort in a text format, you can use d, h, min (or 'p' for points) to indicate the units to use.
original_estimate Set the original estimated effort in minutes.
remaining_estimate Set the remaining estimated effort in minutes.
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
master_feature Name or id of master feature 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.

PUT /api/v1/features/PRJ1-1

Example CURL command

curl "https://company.aha.io/api/v1/features/PRJ1-1" -d $'{"feature":{"progress":25}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
Content-Type: application/json
Accept: application/json
{
  "feature": {
    "progress": 25
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "feature": {
    "id": "1007868956",
    "name": "Feature 1",
    "reference_num": "PRJ1-1",
    "position": 1,
    "score": 3,
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "start_date": "2019-01-01",
    "due_date": "2019-01-01",
    "product_id": 131414752,
    "progress": 25,
    "progress_source": "progress_manual",
    "workflow_kind": {
      "id": "98484309",
      "name": "New"
    },
    "workflow_status": {
      "id": "934242751",
      "name": "New",
      "position": 1,
      "complete": false,
      "color": "#dce7c6"
    },
    "description": {
      "id": "793547626",
      "body": "Body of note 1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "attachments": [
        {
          "id": "724655692",
          "download_url": "http://company.lvh.me/attachments/724655692/token/66dcd9d9b357a1bf891873dd3d21b71235d604ad8154570fdd586bdc3f3d5104.download?size=original",
          "created_at": "2019-01-01T00:00:00.000Z",
          "updated_at": "2019-01-01T00:00:00.000Z",
          "content_type": "text/plain",
          "file_name": "uploaded_file_name.txt",
          "file_size": 123
        }
      ]
    },
    "attachments": [

    ],
    "integration_fields": [
      {
        "id": "728894778",
        "name": "key",
        "value": "JRA-123",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2019-01-01T00:00:00.000Z"
      },
      {
        "id": "846945422",
        "name": "id",
        "value": "435",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2019-01-01T00:00:00.000Z"
      },
      {
        "id": "92040219",
        "name": "url",
        "value": "https://bigaha.atlassian.net/issues/JRA-123",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2019-01-01T00:00:00.000Z"
      }
    ],
    "url": "http://company.aha.io/features/PRJ1-1",
    "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
    "release": {
      "id": "278327321",
      "reference_num": "PRJ1-R-1",
      "name": "Release 1",
      "start_date": "2019-01-01",
      "release_date": "2019-01-01",
      "parking_lot": false,
      "created_at": "2019-01-01T00:00:00.000Z",
      "product_id": 131414752,
      "integration_fields": [
        {
          "id": "68217473",
          "name": "id",
          "value": "777",
          "integration_id": 204584239,
          "service_name": "jira",
          "created_at": "2019-01-01T00:00:00.000Z"
        }
      ],
      "url": "http://company.aha.io/releases/PRJ1-R-1",
      "resource": "http://company.aha.io/api/v1/releases/PRJ1-R-1",
      "owner": {
        "id": "16338845",
        "name": "John Smith",
        "email": "no-reply@aha.io",
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z"
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2019-01-01T00:00:00.000Z"
      }
    },
    "master_feature": {
      "id": "999605892",
      "reference_num": "PRJ1-E-1",
      "name": "Epic 1",
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "http://company.aha.io/epics/PRJ1-E-1",
      "resource": "http://company.aha.io/api/v1/master_features/PRJ1-E-1"
    },
    "belongs_to_release_phase": {
      "id": "20526005",
      "name": "Alpha",
      "start_on": "2019-01-01",
      "end_on": "2019-01-01",
      "type": "phase",
      "release_id": 278327321,
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "progress": null,
      "progress_source": "progress_manual",
      "description": {
        "id": "243384959",
        "body": "Description of release phase 1",
        "created_at": "2019-01-01T00:00:00.000Z",
        "attachments": [

        ]
      }
    },
    "created_by_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z"
    },
    "assigned_to_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "default_assignee": false
    },
    "requirements": [
      {
        "id": "483368544",
        "name": "Body of requirement 1",
        "reference_num": "PRJ1-1-1",
        "position": 1,
        "created_at": "2019-01-01T00:00:00.000Z",
        "updated_at": "2019-01-01T00:00:00.000Z",
        "release_id": 278327321,
        "workflow_status": {
          "id": "934242751",
          "name": "New",
          "position": 1,
          "complete": false,
          "color": "#dce7c6"
        },
        "url": "http://company.aha.io/requirements/PRJ1-1-1",
        "resource": "http://company.aha.io/api/v1/requirements/PRJ1-1-1",
        "description": {
          "id": "910541534",
          "body": "Body of requirement 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "attachments": [

          ]
        },
        "feature": {
          "id": "1007868956",
          "reference_num": "PRJ1-1",
          "name": "Feature 1",
          "created_at": "2019-01-01T00:00:00.000Z",
          "url": "http://company.aha.io/features/PRJ1-1",
          "resource": "http://company.aha.io/api/v1/features/PRJ1-1",
          "product_id": 131414752
        },
        "assigned_to_user": {
          "id": &qu