Products API

Create a product line

POST /api/v1/products

Parameters
NameDescription
name

Name of the product

reference_prefix

Give the product an abbreviation. It will be used as a prefix on all features for this product.

description

Description of the product — may include HTML formatting.

parent_id

Numeric ID or prefix of product line to be parent of the new product. The product line must already exist.

workspace_type

Type of workspace. (e.g. "product_workspace", "it_workspace")

product_line

true

product_line_type

Required if creating a product line

configuration_epics_enabled

Whether epics are enabled for this product. Must be true, false, an empty string ""

configuration_okrs_enabled

Whether objectives and key results are enabled for this product. Must be true, false, an empty string ""

configuration_default_progress_calculations_inherit

Whether the product should inherit the default progress calculations from the parent product. Must be true, or false

configuration_default_progress_calculations_strategic_imperatives

What the default progress calculations should be set to for goals. Must be progress_manual, progress_from_features, progress_from_releases, progress_from_initiatives, progress_from_descendants, progress_from_features_completed, progress_from_epics, or progress_from_key_results

configuration_default_progress_calculations_key_results

What the default progress calculations should be set to for key results. Must be progress_manual, progress_from_initiatives, progress_from_releases, progress_from_epics, progress_from_features, or progress_from_features_completed

configuration_default_progress_calculations_initiatives

What the default progress calculations should be set to for initiatives. Must be progress_manual, progress_from_features, progress_from_releases, progress_from_children, progress_from_features_completed, or progress_from_epics

configuration_default_progress_calculations_releases

What the default progress calculations should be set to for releases. Must be progress_manual, progress_from_features, progress_from_release_phases, progress_from_todos, progress_from_remaining_estimate, progress_from_features_completed, or progress_from_epics

configuration_default_progress_calculations_release_phases

What the default progress calculations should be set to for release phases. Must be progress_manual, progress_from_features, progress_from_todos, or progress_from_features_completed

configuration_default_progress_calculations_epics

What the default progress calculations should be set to for epics. Must be progress_manual, progress_from_features, progress_from_remaining_estimate, progress_from_todos, or progress_from_features_completed

configuration_default_progress_calculations_features

What the default progress calculations should be set to for features. Must be progress_manual, progress_from_requirements, progress_from_remaining_estimate, or progress_from_todos

configuration_default_parent_dates_inherit

Whether the product should inherit the default parent dates from the parent product. Must be true, or false

configuration_default_parent_dates_initiatives

What the default parent dates should be set to for initiatives. Must be duration_manual, duration_from_children, duration_from_releases, or duration_from_features_epics

configuration_default_parent_dates_releases

What the default parent dates should be set to for releases. Must be duration_manual, duration_from_release_phases_features, or duration_from_sub_releases

configuration_default_parent_dates_master_releases

What the default parent dates should be set to for roll-up releases. Must be duration_manual, duration_from_release_phases_features, or duration_from_sub_releases

configuration_default_parent_dates_release_phases

What the default parent dates should be set to for release phases. Must be duration_manual and duration_from_features

configuration_default_parent_dates_epics

What the default parent dates should be set to for epics. Must be duration_manual and duration_from_features

configuration_default_parent_dates_features

What the default parent dates should be set to for features. Must be duration_manual, duration_from_iterations, or duration_from_releases

Example request

POST /api/v1/products

Example CURL command

curl "https://company.aha.io/api/v1/products" -d '{"product":{"name":"New Product Line","description":"An amazing new product line","prefix":"NEWPRODUCT","product_line":true,"product_line_type":"a new product line type"}}' -X POST \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab
contentType: application/json
accept: application/json

Request body

Response

Status: 200 OK
contentType: application/json; charset=utf-8

Response body