Products

Create a product

Changed on
post/products

Request

  • Base URL
    https://company.aha.io/api/v1
  • Auth
    • OAuth 2
      Authorization codehttps://{account-domain}.aha.io/oauth/authorize
      Token URLhttps://{account-domain}.aha.io/oauth/token
    • or HTTP bearer
    • or API key in cookie session
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Request body

Example request

{
  "product": {
    "name": "New Product",
    "description": "An amazing new product",
    "prefix": "NEWPRODUCT"
  }
}

Response

Successful operation

Example response

{
  "product": {
    "id": "6776881149497073946",
    "reference_prefix": "NEWPRODUCT",
    "name": "New Product",
    "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": "6776881149492320383",
      "body": "An amazing new product",
      "notable_id": "6776881149497073946",
      "notable_type": "Project",
      "editor_version": 2,
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "attachments": []
    },
    "url": "https://company.aha.io/projects/NEWPRODUCT",
    "resource": "https://company.aha.io/projects/NEWPRODUCT",
    "children": [],
    "custom_fields": [],
    "screen_definition_ids": {},
    "screen_definitions": [],
    "has_ideas": true,
    "has_master_features": false,
    "has_epics": false,
    "release_workflow": {
      "workflow_type": "release",
      "id": 717623509,
      "name": "Account product release workflow",
      "statusable_type": "Release"
    },
    "feature_workflow": {
      "workflow_type": "feature",
      "id": 499195972,
      "name": "Account product feature workflow",
      "statusable_type": "Feature"
    },
    "initiative_workflow": {
      "workflow_type": "initiative",
      "id": 61191651,
      "name": "Account initiative workflow",
      "statusable_type": "Initiative"
    },
    "epic_workflow": {
      "workflow_type": "epic",
      "id": 499195972,
      "name": "Account product feature workflow",
      "statusable_type": "Feature"
    },
    "idea_workflow": {
      "workflow_type": "idea",
      "id": 80245244,
      "name": "Account product idea workflow",
      "statusable_type": "Idea"
    },
    "strategic_imperative_workflow": {
      "workflow_type": "strategic_imperative",
      "id": 883066232,
      "name": "Account goal workflow",
      "statusable_type": "StrategicImperative"
    },
    "page_workflow": {
      "workflow_type": "page",
      "id": 934299270,
      "name": "Account document workflow",
      "statusable_type": "Page"
    },
    "requirement_workflow": {
      "workflow_type": "requirement",
      "id": 499195972,
      "name": "Account product feature workflow",
      "statusable_type": "Feature"
    },
    "key_result_workflow": {
      "workflow_type": "key_result",
      "id": 883066232,
      "name": "Account goal workflow",
      "statusable_type": "StrategicImperative"
    },
    "capacity_planning_enabled": false,
    "default_capacity_units": 10,
    "enhanced_capacity_planning_enabled": false,
    "workspace_type": "product_workspace",
    "color": "#bf4071"
  }
}

Changes