Releases API


POST /api/v1/products/:product_id/releases

Create a release

Parameters

Name Alias Description
product_id * Numeric ID, or key of the product to create the release in
name * Name of the release
owner Email or ID of the user that will own this release
workflow_status status Status of the release and it must be one of the valid status values for the selected product.
parent The master release of the release if present
theme Theme of the release and it can include HTML formatting.
release_date Release date of the release in format YYYY-MM-DD
development_started_on Date Development started in format YYYY-MM-DD
parking_lot Sets whether this release is a parking lot
external_release_date The external release date for this feature in format YYYY-MM-DD
external_date_resolution Rounds the external release date to the nearest resolution value, can be one of: sync, exact, week, month, quarter, half, year
capacity_units The units for this release, either time or story_points
total_capacity_text The total capacity for this release, For time: use min, h, d, w, m to represent time (e.g. "2d 1h") 8h = 1d, 5d = 1w, 22d = 1m. For story points: Use p to represent points (e.g. "4p").

POST /api/v1/products/PRJ1/releases

Example CURL command

curl "https://secure.aha.io/api/v1/products/PRJ1/releases" -d '{"release":{"owner":"mary.humpty@account1.com","name":"Release 3","status":"New","theme":"Our first big release","external_date_resolution":"month"}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "X-Aha-Account: account1" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
X-Aha-Account: account1
Content-Type: application/json
Accept: application/json
{
  "release": {
    "owner": "mary.humpty@account1.com",
    "name": "Release 3",
    "status": "New",
    "theme": "Our first big release",
    "external_date_resolution": "month"
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "release": {
    "id": "6477599799157489029",
    "product_id": "131414752",
    "reference_num": "PRJ1-R-3",
    "name": "Release 3",
    "start_date": "2017-11-16",
    "release_date": "2017-11-16",
    "external_release_date": "2017-11-16",
    "external_release_date_description": "November 2017",
    "external_date_resolution": "month",
    "released": false,
    "parking_lot": false,
    "created_at": "2017-10-16T19:55:30.567Z",
    "updated_at": "2017-10-16T19:55:30.567Z",
    "position": 1,
    "theme": {
      "id": "6477599799235575136",
      "body": "Our first big release",
      "created_at": "2017-10-16T19:55:30.585Z",
      "attachments": [

      ]
    },
    "url": "http://account1.example.org/releases/PRJ1-R-3",
    "resource": "http://account1.example.org/api/v1/releases/PRJ1-R-3",
    "integration_fields": [

    ],
    "custom_fields": [

    ],
    "comments_count": 0,
    "workflow_status": {
      "id": "738862546",
      "name": "New",
      "complete": false
    },
    "owner": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2017-10-16T19:54:35.000Z",
      "updated_at": "2017-10-16T19:54:35.000Z"
    },
    "project": {
      "id": "131414752",
      "reference_prefix": "PRJ1",
      "name": "Project 1",
      "product_line": false,
      "created_at": "2017-10-16T19:54:35.000Z"
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2017-10-16T19:54:35.000Z",
      "updated_at": "2017-10-16T19:54:35.000Z"
    }
  }
}

POST /api/v1/products/:product_id/releases

Create a parking lot release

Parameters

Name Alias Description
product_id * Numeric ID, or key of the product to create the release in
name * Name of the release
owner Email or ID of the user that will own this release
workflow_status status Status of the release and it must be one of the valid status values for the selected product.
parent The master release of the release if present
theme Theme of the release and it can include HTML formatting.
release_date Release date of the release in format YYYY-MM-DD
development_started_on Date Development started in format YYYY-MM-DD
parking_lot Sets whether this release is a parking lot
external_release_date The external release date for this feature in format YYYY-MM-DD
external_date_resolution Rounds the external release date to the nearest resolution value, can be one of: sync, exact, week, month, quarter, half, year
capacity_units The units for this release, either time or story_points
total_capacity_text The total capacity for this release, For time: use min, h, d, w, m to represent time (e.g. "2d 1h") 8h = 1d, 5d = 1w, 22d = 1m. For story points: Use p to represent points (e.g. "4p").

POST /api/v1/products/PRJ1/releases

Example CURL command

curl "https://secure.aha.io/api/v1/products/PRJ1/releases" -d '{"release":{"owner":"mary.humpty@account1.com","name":"Release 3","status":"New","theme":"Our first big release","external_date_resolution":"week","parking_lot":true}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "X-Aha-Account: account1" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
X-Aha-Account: account1
Content-Type: application/json
Accept: application/json
{
  "release": {
    "owner": "mary.humpty@account1.com",
    "name": "Release 3",
    "status": "New",
    "theme": "Our first big release",
    "external_date_resolution": "week",
    "parking_lot": true
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "release": {
    "id": "6477599799966668945",
    "product_id": "131414752",
    "reference_num": "PRJ1-R-3",
    "name": "Release 3",
    "released": false,
    "parking_lot": true,
    "created_at": "2017-10-16T19:55:30.759Z",
    "updated_at": "2017-10-16T19:55:30.759Z",
    "position": 1,
    "theme": {
      "id": "6477599800056748632",
      "body": "Our first big release",
      "created_at": "2017-10-16T19:55:30.776Z",
      "attachments": [

      ]
    },
    "url": "http://account1.example.org/releases/PRJ1-R-3",
    "resource": "http://account1.example.org/api/v1/releases/PRJ1-R-3",
    "integration_fields": [

    ],
    "custom_fields": [

    ],
    "comments_count": 0,
    "workflow_status": {
      "id": "738862546",
      "name": "New",
      "complete": false
    },
    "owner": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2017-10-16T19:54:35.000Z",
      "updated_at": "2017-10-16T19:54:35.000Z"
    },
    "project": {
      "id": "131414752",
      "reference_prefix": "PRJ1",
      "name": "Project 1",
      "product_line": false,
      "created_at": "2017-10-16T19:54:35.000Z"
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "mary.humpty@account1.com",
      "created_at": "2017-10-16T19:54:35.000Z",
      "updated_at": "2017-10-16T19:54:35.000Z"
    }
  }
}

GET /api/v1/products/:product_id/releases

Get all releases in a product

Parameters

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

GET /api/v1/products/PRJ1/releases

Example CURL command

curl -g "https://secure.aha.io/api/v1/products/PRJ1/releases" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "X-Aha-Account: account1" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
X-Aha-Account: account1
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "releases": [
    {
      "id": "161456549",
      "reference_num": "PRJ1-R-2",
      "name": "Release 2",
      "start_date": "2017-09-16",
      "release_date": "2017-10-23",
      "parking_lot": false,
      "created_at": "2017-10-16T19:54:35.000Z",
      "integration_fields": [

      ],
      "url": "http://account1.example.org/releases/PRJ1-R-2",
      "resource": "http://account1.example.org/api/v1/releases/PRJ1-R-2",
      "owner": {
        "id": "16338845",
        "name": "John Smith",
        "email": "john.smith@account1.com",
        "created_at": "2017-10-16T19:54:35.000Z",
        "updated_at": "2017-10-16T19:54:35.000Z"
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2017-10-16T19:54:35.000Z"
      }
    },
    {
      "id": "278327321",
      "reference_num": "PRJ1-R-1",
      "name": "Release 1",
      "start_date": "2017-10-23",
      "release_date": "2017-10-23",
      "parking_lot": false,
      "created_at": "2017-10-16T19:54:35.000Z",
      "integration_fields": [
        {
          "id": "68217473",
          "name": "id",
          "value": "777",
          "integration_id": 204584239,
          "service_name": "jira",
          "created_at": "2017-10-16T19:54:35.000Z"
        }
      ],
      "url": "http://account1.example.org/releases/PRJ1-R-1",
      "resource": "http://account1.example.org/api/v1/releases/PRJ1-R-1",
      "owner": {
        "id": "16338845",
        "name": "John Smith",
        "email": "john.smith@account1.com",
        "created_at": "2017-10-16T19:54:35.000Z",
        "updated_at": "2017-10-16T19:54:35.000Z"
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2017-10-16T19:54:35.000Z"
      }
    },
    {
      "id": "292454904",
      "reference_num": "PRJ1-MR-1",
      "name": "Master Release 1",
      "start_date": "2017-09-16",
      "release_date": "2017-10-23",
      "parking_lot": false,
      "created_at": "2017-10-16T19:54:35.000Z",
      "integration_fields": [

      ],
      "url": "http://account1.example.org/master_releases/PRJ1-MR-1",
      "resource": "http://account1.example.org/api/v1/releases/PRJ1-MR-1",
      "owner": {
        "id": "16338845",
        "name": "John Smith",
        "email": "john.smith@account1.com",
        "created_at": "2017-10-16T19:54:35.000Z",
        "updated_at": "2017-10-16T19:54:35.000Z"
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2017-10-16T19:54:35.000Z"
      }
    },
    {
      "id": "1050186040",
      "reference_num": "PRJ1-R-3",
      "name": "Release 3",
      "start_date": "2017-09-16",
      "release_date": "2017-10-30",
      "parking_lot": false,
      "created_at": "2017-10-16T19:54:35.000Z",
      "integration_fields": [

      ],
      "url": "http://account1.example.org/releases/PRJ1-R-3",
      "resource": "http://account1.example.org/api/v1/releases/PRJ1-R-3",
      "owner": {
        "id": "16338845",
        "name": "John Smith",
        "email": "john.smith@account1.com",
        "created_at": "2017-10-16T19:54:35.000Z",
        "updated_at": "2017-10-16T19:54:35.000Z"
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2017-10-16T19:54:35.000Z"
      }
    }
  ],
  "pagination": {
    "total_records": 4,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/releases

Search releases by name or ID

Parameters

Name Description
q Sub-string to match against release name or ID

GET /api/v1/releases?q=ease

Example CURL command

curl -g "https://secure.aha.io/api/v1/releases?q=ease" -X GET \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "X-Aha-Account: account1" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
X-Aha-Account: account1
Content-Type: application/json
Accept: application/json

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "releases": [
    {
      "id": "161456549",
      "reference_num": "PRJ1-R-2",
      "name": "Release 2",
      "start_date": "2017-09-16",
      "release_date": "2017-10-23",
      "parking_lot": false,
      "created_at": "2017-10-16T19:54:35.000Z",
      "integration_fields": [

      ],
      "url": "http://account1.example.org/releases/PRJ1-R-2",
      "resource": "http://account1.example.org/api/v1/releases/PRJ1-R-2",
      "owner": {
        "id": "16338845",
        "name": "John Smith",
        "email": "john.smith@account1.com",
        "created_at": "2017-10-16T19:54:35.000Z",
        "updated_at": "2017-10-16T19:54:35.000Z"
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2017-10-16T19:54:35.000Z"
      }
    },
    {
      "id": "278327321",
      "reference_num": "PRJ1-R-1",
      "name": "Release 1",
      "start_date": "2017-10-23",
      "release_date": "2017-10-23",
      "parking_lot": false,
      "created_at": "2017-10-16T19:54:35.000Z",
      "integration_fields": [
        {
          "id": "68217473",
          "name": "id",
          "value": "777",
          "integration_id": 204584239,
          "service_name": "jira",
          "created_at": "2017-10-16T19:54:35.000Z"
        }
      ],
      "url": "http://account1.example.org/releases/PRJ1-R-1",
      "resource": "http://account1.example.org/api/v1/releases/PRJ1-R-1",
      "owner": {
        "id": "16338845",
        "name": "John Smith",
        "email": "john.smith@account1.com",
        "created_at": "2017-10-16T19:54:35.000Z",
        "updated_at": "2017-10-16T19:54:35.000Z"
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2017-10-16T19:54:35.000Z"
      }
    },
    {
      "id": "292454904",
      "reference_num": "PRJ1-MR-1",
      "name": "Master Release 1",
      "start_date": "2017-09-16",
      "release_date": "2017-10-23",
      "parking_lot": false,
      "created_at": "2017-10-16T19:54:35.000Z",
      "integration_fields": [

      ],
      "url": "http://account1.example.org/master_releases/PRJ1-MR-1",
      "resource": "http://account1.example.org/api/v1/releases/PRJ1-MR-1",
      "owner": {
        "id": "16338845",
        "name": "John Smith",
        "email": "john.smith@account1.com",
        "created_at": "2017-10-16T19:54:35.000Z",
        "updated_at": "2017-10-16T19:54:35.000Z"
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2017-10-16T19:54:35.000Z"
      }
    },
    {
      "id": "1000426269",
      "reference_num": "PRJ2-R-1",
      "name": "Release 2",
      "start_date": "2017-09-16",
      "release_date": "2017-10-23",
      "parking_lot": false,
      "created_at": "2017-10-16T19:54:35.000Z",
      "integration_fields": [

      ],
      "url": "http://account1.example.org/releases/PRJ2-R-1",
      "resource": "http://account1.example.org/api/v1/releases/PRJ2-R-1",
      "owner": {
        "id": "16338845",
        "name": "John Smith",
        "email": "john.smith@account1.com",
        "created_at": "2017-10-16T19:54:35.000Z",
        "updated_at": "2017-10-16T19:54:35.000Z"
      },
      "project": {
        "id": "517761884",
        "reference_prefix": "PRJ2",
        "name": "Project 2",
        "product_line": false,
        "created_at": "2017-10-16T19:54:35.000Z"
      }
    },
    {
      "id": "342040612",
      "reference_num": "PRJ3-R-1",
      "name": "Release 3",
      "start_date": "2017-09-16",
      "release_date": "2017-10-23",
      "parking_lot": false,
      "created_at": "2017-10-16T19:54:35.000Z",
      "integration_fields": [

      ],
      "url": "http://account1.example.org/releases/PRJ3-R-1",
      "resource": "http://account1.example.org/api/v1/releases/PRJ3-R-1",
      "owner": {
        "id": "16338845",
        "name": "John Smith",
        "email": "john.smith@account1.com",
        "created_at": "2017-10-16T19:54:35.000Z",
        "updated_at": "2017-10-16T19:54:35.000Z"
      },
      "project": {
        "id": "702241743",
        "reference_prefix": "PRJ3",
        "name": "Project 3",
        "product_line": false,
        "created_at": "2017-10-16T19:54:35.000Z"
      }
    },
    {
      "id": "918502240",
      "reference_num": "PRJ4-R-1",
      "name": "Release 4",
      "start_date": "2017-09-16",
      "release_date": "2017-10-23",
      "parking_lot": false,
      "created_at": "2017-10-16T19:54:35.000Z",
      "integration_fields": [

      ],
      "url": "http://account1.example.org/releases/PRJ4-R-1",
      "resource": "http://account1.example.org/api/v1/releases/PRJ4-R-1",
      "owner": {
        "id": "16338845",
        "name": "John Smith",
        "email": "john.smith@account1.com",
        "created_at": "2017-10-16T19:54:35.000Z",
        "updated_at": "2017-10-16T19:54:35.000Z"
      },
      "project": {
        "id": "935317104",
        "reference_prefix": "PRJ4",
        "name": "Project 4",
        "product_line": false,
        "created_at": "2017-10-16T19:54:35.000Z"
      }
    },
    {
      "id": "1050186040",
      "reference_num": "PRJ1-R-3",
      "name": "Release 3",
      "start_date": "2017-09-16",
      "release_date": "2017-10-30",
      "parking_lot": false,
      "created_at": "2017-10-16T19:54:35.000Z",
      "integration_fields": [

      ],
      "url": "http://account1.example.org/releases/PRJ1-R-3",
      "resource": "http://account1.example.org/api/v1/releases/PRJ1-R-3",
      "owner": {
        "id": "16338845",
        "name": "John Smith",
        "email": "john.smith@account1.com",
        "created_at": "2017-10-16T19:54:35.000Z",
        "updated_at": "2017-10-16T19:54:35.000Z"
      },
      "project": {
        "id": "131414752",
        "reference_prefix": "PRJ1",
        "name": "Project 1",
        "product_line": false,
        "created_at": "2017-10-16T19:54:35.000Z"
      }
    }
  ],
  "pagination": {
    "total_records": 7,
    "total_pages": 1,
    "current_page": 1
  }
}

GET /api/v1/releases/:id

Get a specific release

Parameters

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

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

Example CURL command

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

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
X-Aha-Account: account1
Content-Type: application/json
Accept: application/json

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": "2017-10-23",
    "release_date": "2017-10-23",
    "external_release_date": "2017-10-23",
    "external_release_date_description": "Oct 23, 2017",
    "external_date_resolution": "exact",
    "released": false,
    "parking_lot": false,
    "created_at": "2017-10-16T19:54:35.000Z",
    "updated_at": "2017-10-16T19:54:35.000Z",
    "position": null,
    "theme": {
      "id": "522610666",
      "body": "Theme of the release",
      "created_at": "2017-10-16T19:54:35.000Z",
      "attachments": [

      ]
    },
    "url": "http://account1.example.org/releases/PRJ1-R-1",
    "resource": "http://account1.example.org/api/v1/releases/PRJ1-R-1",
    "integration_fields": [
      {
        "id": "68217473",
        "name": "id",
        "value": "777",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2017-10-16T19:54:35.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": "2017-10-16T19:54:34.000Z",
        "attachments": [

        ],
        "value": "<p>sample text</p>",
        "type": "note"
      }
    ],
    "comments_count": 1,
    "workflow_status": {
      "id": "738862546",
      "name": "New",
      "complete": false
    },
    "owner": {
      "id": "16338845",
      "name": "John Smith",
      "email": "john.smith@account1.com",
      "created_at": "2017-10-16T19:54:35.000Z",
      "updated_at": "2017-10-16T19:54:35.000Z"
    },
    "project": {
      "id": "131414752",
      "reference_prefix": "PRJ1",
      "name": "Project 1",
      "product_line": false,
      "created_at": "2017-10-16T19:54:35.000Z"
    },
    "created_by_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "john.smith@account1.com",
      "created_at": "2017-10-16T19:54:35.000Z",
      "updated_at": "2017-10-16T19:54:35.000Z"
    }
  }
}

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

Update a release

Parameters

Name Alias Description
product_id * Numeric ID, or key of the product to create the release in
id * Numeric ID, or key of the release to be updated
name Name of the release
owner Email or ID of the user that will own this release
workflow_status status Status of the release and it must be one of the valid status values for the selected product.
parent The master release of the release if present
theme Theme of the release and it can include HTML formatting.
release_date Release date of the release in format YYYY-MM-DD
development_started_on Date Development started in format YYYY-MM-DD
parking_lot Sets whether this release is a parking lot
external_release_date The external release date for this feature in format YYYY-MM-DD
external_date_resolution Rounds the external release date to the nearest resolution value, can be one of: sync, exact, week, month, quarter, half, year
capacity_units The units for this release, either time or story_points
total_capacity_text The total capacity for this release, For time: use min, h, d, w, m to represent time (e.g. "2d 1h") 8h = 1d, 5d = 1w, 22d = 1m. For story points: Use p to represent points (e.g. "4p").

PUT /api/v1/products/PRJ1/releases/278327321

Example CURL command

curl "https://secure.aha.io/api/v1/products/PRJ1/releases/278327321" -d '{"release":{"name":"Smarter release"}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "X-Aha-Account: account1" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
X-Aha-Account: account1
Content-Type: application/json
Accept: application/json
{
  "release": {
    "name": "Smarter release"
  }
}

Response

Status: 200 OK
  Content-Type: application/json; charset=utf-8
{
  "release": {
    "id": "278327321",
    "product_id": "131414752",
    "reference_num": "PRJ1-R-1",
    "name": "Smarter release",
    "start_date": "2017-10-23",
    "release_date": "2017-10-23",
    "external_release_date": "2017-10-23",
    "external_release_date_description": "Oct 23, 2017",
    "external_date_resolution": "exact",
    "released": false,
    "parking_lot": false,
    "created_at": "2017-10-16T19:54:35.000Z",
    "updated_at": "2017-10-16T19:55:31.305Z",
    "position": null,
    "theme": {
      "id": "522610666",
      "body": "Theme of the release",
      "created_at": "2017-10-16T19:54:35.000Z",
      "attachments": [

      ]
    },
    "url": "http://account1.example.org/releases/PRJ1-R-1",
    "resource": "http://account1.example.org/api/v1/releases/PRJ1-R-1",
    "integration_fields": [
      {
        "id": "68217473",
        "name": "id",
        "value": "777",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2017-10-16T19:54:35.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": "2017-10-16T19:54:34.000Z",
        "attachments": [

        ],
        "value": "<p>sample text</p>",
        "type": "note"
      }
    ],
    "comments_count": 1,
    "workflow_status": {
      "id": "738862546",
      "name": "New",
      "complete": false
    },
    "owner": {
      "id": "16338845",
      "name": "John Smith",
      "email": "john.smith@account1.com",
      "created_at": "2017-10-16T19:54:35.000Z",
      "updated_at": "2017-10-16T19:54:35.000Z"
    },
    "project": {
      "id": "131414752",
      "reference_prefix": "PRJ1",
      "name": "Project 1",
      "product_line": false,
      "created_at": "2017-10-16T19:54:35.000Z"
    },
    "created_by_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "john.smith@account1.com",
      "created_at": "2017-10-16T19:54:35.000Z",
      "updated_at": "2017-10-16T19:54:35.000Z"
    }
  }
}

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

Set initiatives for an release

Parameters

Name Alias Description
product_id * Numeric ID, or key of the product to create the release in
id * Numeric ID, or key of the release to be updated
name Name of the release
owner Email or ID of the user that will own this release
workflow_status status Status of the release and it must be one of the valid status values for the selected product.
parent The master release of the release if present
theme Theme of the release and it can include HTML formatting.
release_date Release date of the release in format YYYY-MM-DD
development_started_on Date Development started in format YYYY-MM-DD
parking_lot Sets whether this release is a parking lot
external_release_date The external release date for this feature in format YYYY-MM-DD
external_date_resolution Rounds the external release date to the nearest resolution value, can be one of: sync, exact, week, month, quarter, half, year
capacity_units The units for this release, either time or story_points
total_capacity_text The total capacity for this release, For time: use min, h, d, w, m to represent time (e.g. "2d 1h") 8h = 1d, 5d = 1w, 22d = 1m. For story points: Use p to represent points (e.g. "4p").

PUT /api/v1/products/PRJ1/releases/278327321

Example CURL command

curl "https://secure.aha.io/api/v1/products/PRJ1/releases/278327321" -d '{"release":{"initiatives":[4125886]}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "X-Aha-Account: account1" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
X-Aha-Account: account1
Content-Type: application/json
Accept: application/json
{
  "release": {
    "initiatives": [
      4125886
    ]
  }
}

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": "2017-10-23",
    "release_date": "2017-10-23",
    "external_release_date": "2017-10-23",
    "external_release_date_description": "Oct 23, 2017",
    "external_date_resolution": "exact",
    "released": false,
    "parking_lot": false,
    "created_at": "2017-10-16T19:54:35.000Z",
    "updated_at": "2017-10-16T19:54:35.000Z",
    "position": null,
    "theme": {
      "id": "522610666",
      "body": "Theme of the release",
      "created_at": "2017-10-16T19:54:35.000Z",
      "attachments": [

      ]
    },
    "url": "http://account1.example.org/releases/PRJ1-R-1",
    "resource": "http://account1.example.org/api/v1/releases/PRJ1-R-1",
    "integration_fields": [
      {
        "id": "68217473",
        "name": "id",
        "value": "777",
        "integration_id": 204584239,
        "service_name": "jira",
        "created_at": "2017-10-16T19:54:35.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": "2017-10-16T19:54:34.000Z",
        "attachments": [

        ],
        "value": "<p>sample text</p>",
        "type": "note"
      }
    ],
    "comments_count": 1,
    "workflow_status": {
      "id": "738862546",
      "name": "New",
      "complete": false
    },
    "owner": {
      "id": "16338845",
      "name": "John Smith",
      "email": "john.smith@account1.com",
      "created_at": "2017-10-16T19:54:35.000Z",
      "updated_at": "2017-10-16T19:54:35.000Z"
    },
    "project": {
      "id": "131414752",
      "reference_prefix": "PRJ1",
      "name": "Project 1",
      "product_line": false,
      "created_at": "2017-10-16T19:54:35.000Z"
    },
    "created_by_user": {
      "id": "16338845",
      "name": "John Smith",
      "email": "john.smith@account1.com",
      "created_at": "2017-10-16T19:54:35.000Z",
      "updated_at": "2017-10-16T19:54:35.000Z"
    }
  }
}

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

Delete a release

Parameters

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

DELETE /api/v1/products/PRJ1/releases/161456549

Example CURL command

curl "https://secure.aha.io/api/v1/products/PRJ1/releases/161456549" -d '' -X DELETE \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "X-Aha-Account: account1" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
X-Aha-Account: account1
Content-Type: application/json
Accept: application/json

Response

Status: 204 No Content
  

Overview

API Resources