---
canonical_url: "https://docs.composio.dev/toolkits/aha"
markdown_url: "https://docs.composio.dev/toolkits/aha.md"
product: "platform"
version: null
last_updated: null
---

# Aha!

Aha! helps product teams set strategy, prioritize ideas, plan roadmaps, and manage product development work.

- **Category:** product management
- **Auth:** OAUTH2
- **Composio-managed OAuth available?** No
- **Tools:** 112
- **Triggers:** 0
- **Slug:** `AHA`
- **Version:** 00000000_00

## Tools

### Add Product Idea Portals

**Slug:** `AHA_ADD_PRODUCT_IDEA_PORTALS`

Add idea portal links to a product without replacing existing links.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `product_id` | string | Yes | Numeric ID or key of the product. |
| `idea_portal_ids` | array | Yes | Idea portal IDs to add without removing existing links. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Convert Feature to Epic

**Slug:** `AHA_CONVERT_FEATURE_TO_EPIC`

Irreversibly convert an existing feature into an epic while preserving its data and relationships.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `feature_id` | string | Yes | Feature ID or reference number to convert into an epic. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Convert Requirement to Feature

**Slug:** `AHA_CONVERT_REQUIREMENT_TO_FEATURE`

Irreversibly convert an existing requirement into a feature.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `requirement_id` | string | Yes | Requirement ID or reference number to convert into a feature. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Custom Field Option

**Slug:** `AHA_CREATE_CUSTOM_FIELD_OPTION`

Create an option for one custom-field definition.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `color` | integer | No | Base-10 representation of the option's hexadecimal RGB color. |
| `value` | string | Yes | Value displayed for the new option. |
| `custom_field_definition_id` | string | Yes | Custom-field definition ID that will own the option. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Epic

**Slug:** `AHA_CREATE_EPIC`

Create an epic in a release or in a workspace's default release.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the epic. |
| `tags` | string | No | Comma-separated tags to add to the epic. |
| `goals` | array | No | Goal names or IDs to associate with the epic. |
| `due_date` | string | No | Due date in YYYY-MM-DD format. |
| `created_by` | string | No | Email address of the user creating the epic. |
| `initiative` | string | No | Initiative name or ID to associate with the epic. |
| `start_date` | string | No | Start date in YYYY-MM-DD format. |
| `description` | string | No | Epic description; HTML is accepted. |
| `destination_id` | string | Yes | Release ID or workspace ID selected by destination_type. |
| `duration_source` | string ("duration_manual" | "duration_from_features" | "duration_from_releases") | No | Method used to calculate epic dates. |
| `workflow_status` | string | No | Workflow status name valid for the workspace. |
| `assigned_to_user` | string | No | Email address of the user assigned to the epic. |
| `destination_type` | string ("release" | "workspace_default_release") | Yes | Whether to create the epic in a release or a workspace's default release. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Feature

**Slug:** `AHA_CREATE_FEATURE`

Create a feature in a release with its documented planning fields.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `epic` | string | No | Epic name or ID. |
| `name` | string | Yes | Name of the feature. |
| `tags` | string | No | Comma-separated tags to add to the feature. |
| `team` | string | No | Team ID or key. |
| `goals` | array | No | Goal names or IDs to associate with the feature. |
| `release` | string | No | Release ID or key to assign to the feature. |
| `due_date` | string | No | Due date in YYYY-MM-DD format. |
| `progress` | string | No | Completion progress when progress_source is progress_manual. |
| `iteration` | string | No | Sprint ID. |
| `created_by` | string | No | Email address of the user who created the feature. |
| `initiative` | string | No | Initiative name or ID. |
| `release_id` | string | Yes | Release ID or reference number in which to create the feature. |
| `start_date` | string | No | Start date in YYYY-MM-DD format. |
| `description` | string | No | Feature description, which may contain HTML. |
| `release_phase` | string | No | Release phase name or ID. |
| `workflow_kind` | string | No | Feature workflow-kind identifier configured for the release's workspace (for example, new); use AHA_LIST_WORKFLOWS to discover available values. |
| `progress_source` | string ("progress_manual" | "progress_from_requirements" | "progress_from_requirements_with_dependents" | "progress_from_remaining_estimate" | "progress_from_remaining_estimate_with_dependents" | "progress_from_todos" | "progress_from_todos_with_dependents") | No | Method used to calculate feature progress. |
| `workflow_status` | object | No | Workflow status, identified by name or ID. |
| `assigned_to_user` | object | No | Assigned user, identified by email. |
| `initial_estimate` | string | No | Initial estimate in the workspace's configured capacity units. |
| `detailed_estimate` | string | No | Detailed estimate in the workspace's configured capacity units. |
| `program_increment` | string | No | Program increment ID or key. |
| `remaining_estimate` | string | No | Remaining estimate in the workspace's configured capacity units. |
| `team_workflow_status` | string | No | Valid team status. |
| `initial_estimate_text` | string | No | Initial estimate using time units (for example, 2d 1h) or story points (for example, 4p). |
| `detailed_estimate_text` | string | No | Detailed estimate using time units or story points. |
| `remaining_estimate_text` | string | No | Remaining estimate using time units or story points. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Goal

**Slug:** `AHA_CREATE_GOAL`

Create a strategic goal in one Aha! workspace or product line.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the new goal. |
| `value` | integer | No | Value score from 1 to 100. |
| `effort` | integer | No | Effort score from 1 to 100. |
| `progress` | number | No | Manual completion percentage from 0 to 100. |
| `watchers` | array | No | Aha! user IDs to add as goal watchers. |
| `parent_id` | string | No | Parent goal ID, when this goal rolls up. |
| `product_id` | string | Yes | Workspace or product-line ID or reference prefix. |
| `time_frame` | object | No | Strategic time frame selected by ID or name. |
| `description` | string | No | Goal description; HTML is accepted. |
| `custom_fields` | array | No | Custom-field values to set on the goal. |
| `success_metric` | object | Yes | Metric used to determine whether the goal succeeds. |
| `progress_source` | string ("progress_manual" | "progress_from_features" | "progress_from_features_with_dependents" | "progress_from_releases" | "progress_from_releases_with_dependents" | "progress_from_initiatives" | "progress_from_initiatives_with_dependents" | "progress_from_descendants" | "progress_from_descendants_with_dependents" | "progress_from_features_completed" | "progress_from_features_completed_with_dependents" | "progress_from_epics" | "progress_from_epics_with_dependents" | "progress_from_key_results" | "progress_from_key_results_with_dependents") | No | Progress source: progress_manual, progress_from_features, progress_from_features_with_dependents, progress_from_releases, progress_from_releases_with_dependents, progress_from_initiatives, progress_from_initiatives_with_dependents, progress_from_descendants, progress_from_descendants_with_dependents, progress_from_features_completed, progress_from_features_completed_with_dependents, progress_from_epics, progress_from_epics_with_dependents, progress_from_key_results, or progress_from_key_results_with_dependents. |
| `workflow_status` | string | No | Goal workflow status name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Idea

**Slug:** `AHA_CREATE_IDEA`

Create an idea in a product with the documented idea fields.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `epic` | string | No | Name or ID of a promoted epic. |
| `name` | string | Yes | Name of the idea. |
| `spam` | boolean | No | Whether the idea is spam. |
| `tags` | string | No | Comma-separated tags for the idea. |
| `themes` | string | No | Comma-separated numeric idea theme IDs. |
| `feature` | string | No | Name or ID of a promoted feature. |
| `categories` | string | No | Comma-separated existing category names. |
| `created_at` | string | No | Creation date in UTC as YYYY-MM-DD or YYYY-MM-DD HH:MM:SS. |
| `created_by` | string | No | Email address of the user who created the idea. |
| `initiative` | string | No | Name or ID of a promoted initiative. |
| `product_id` | string | Yes | Numeric ID or key of the product. |
| `visibility` | string ("aha" | "creator" | "employee" | "employee_or_creator" | "creator_organization" | "public") | No | Initial idea visibility; defaults to aha. |
| `description` | string | No | Idea description, which may contain HTML. |
| `initial_votes` | integer | No | Vote count to seed when importing the idea. |
| `duplicate_idea` | string | No | ID or key of an idea that this idea duplicates. |
| `workflow_status` | string | No | Valid workflow status ID or name for the product. |
| `assigned_to_user` | string | No | Email address of the user assigned to the idea. |
| `portal_restricted` | boolean | No | Whether the idea is restricted to specific portals. |
| `submitted_idea_portal_id` | string | No | Numeric idea portal ID through which the idea is submitted. |
| `restricted_idea_portal_ids` | array | No | Portal IDs allowed to access the restricted idea. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Idea Theme

**Slug:** `AHA_CREATE_IDEA_THEME`

Create an idea theme in a product.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the idea theme. |
| `product_id` | string | Yes | Numeric ID or key of the product that will contain the theme. |
| `description_attributes` | object | No | Rich-text description attributes for the theme. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Initiative

**Slug:** `AHA_CREATE_INITIATIVE`

Create a strategic initiative in one Aha! workspace or product line.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the new initiative. |
| `goals` | array | No | Associated goal IDs or names. |
| `value` | string | No | Business value of the initiative. |
| `effort` | string | No | Effort required for the initiative. |
| `end_date` | string | No | End date in YYYY-MM-DD format. |
| `position` | integer | No | Initiative ordering position. |
| `progress` | number | No | Manual completion percentage. |
| `watchers` | array | No | Aha! user IDs to add as watchers. |
| `parent_id` | string | No | Parent initiative ID. |
| `presented` | boolean | No | Whether to show the initiative on charts. |
| `product_id` | string | Yes | Workspace or product-line ID or reference prefix. |
| `start_date` | string | No | Start date in YYYY-MM-DD format. |
| `time_frame` | object | No | Strategic time frame by ID or name. |
| `description` | string | No | Initiative description; HTML is accepted. |
| `custom_fields` | array | No | Custom-field values. |
| `duration_source` | string ("duration_manual" | "duration_from_children" | "duration_from_releases" | "duration_from_features_epics") | No | Duration source: duration_manual, duration_from_children, duration_from_releases, or duration_from_features_epics. |
| `progress_source` | string ("progress_manual" | "progress_from_features" | "progress_from_features_with_dependents" | "progress_from_releases" | "progress_from_releases_with_dependents" | "progress_from_children" | "progress_from_children_with_dependents" | "progress_from_features_completed" | "progress_from_features_completed_with_dependents" | "progress_from_epics" | "progress_from_epics_with_dependents") | No | Progress source: progress_manual, progress_from_features, progress_from_features_with_dependents, progress_from_releases, progress_from_releases_with_dependents, progress_from_children, progress_from_children_with_dependents, progress_from_features_completed, progress_from_features_completed_with_dependents, progress_from_epics, or progress_from_epics_with_dependents. |
| `workflow_status` | object | Yes | Initial workflow status by ID or name. |
| `assigned_to_user` | string | No | Email address of the assigned Aha! user. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Key Result

**Slug:** `AHA_CREATE_KEY_RESULT`

Create a key result under one strategic goal.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the new key result. |
| `goal_id` | string | Yes | Goal ID or reference number. |
| `watchers` | array | No | Aha! user IDs to add as watchers. |
| `description` | string | No | Key-result description; HTML is accepted. |
| `custom_fields` | array | No | Custom-field values. |
| `target_metric` | string | No | Target metric value. |
| `current_metric` | string | No | Current metric value. |
| `starting_metric` | string | No | Starting metric value. |
| `workflow_status` | object | No | Initial workflow status by name. |
| `assigned_to_user` | object | No | User assigned by email address. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Parking-Lot Release

**Slug:** `AHA_CREATE_PARKING_LOT_RELEASE`

Create a parking-lot release in a workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the parking-lot release. |
| `goals` | array | No | Goal names or IDs to associate with the release. |
| `owner` | string | No | Email address or ID of the release owner. |
| `theme` | string | No | Release theme; HTML is accepted. |
| `end_date` | string | No | End date in YYYY-MM-DD format. |
| `parent_id` | string | No | ID of the parent roll-up release. |
| `product_id` | string | Yes | Workspace ID in which to create the release. |
| `start_date` | string | No | Start date in YYYY-MM-DD format. |
| `initiatives` | array | No | Initiative names or IDs to associate with the release. |
| `capacity_units` | string ("time" | "story_points") | No | Capacity units used by the release. |
| `workflow_status` | string | No | Workflow status name valid for the workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Product

**Slug:** `AHA_CREATE_PRODUCT`

Create an Aha! product workspace with a name, description, and reference prefix.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the new Aha! workspace. |
| `prefix` | string | Yes | Reference prefix for records in the workspace. |
| `description` | string | No | Description of the new workspace. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Product Contributor

**Slug:** `AHA_CREATE_PRODUCT_CONTRIBUTOR`

Create an Aha! contributor user associated with a product.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `role` | string | No | Product role for the new user. |
| `email` | string | Yes | Email address for the new user. |
| `last_name` | string | Yes | New user's last name. |
| `first_name` | string | Yes | New user's first name. |
| `product_id` | string | Yes | Aha! product ID or reference prefix. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Product Roll-Up Release

**Slug:** `AHA_CREATE_PRODUCT_ROLLUP_RELEASE`

Create a roll-up release in a product line, optionally adding workspaces.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the new roll-up release. |
| `theme` | string | No | Roll-up release theme; HTML is accepted. |
| `product_id` | string | Yes | Product-line numeric ID or key. |
| `project_ids` | array | No | Workspace IDs or keys to add to the roll-up release. |
| `release_date` | string | No | Roll-up release date in YYYY-MM-DD format. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Release Milestone

**Slug:** `AHA_CREATE_RELEASE_MILESTONE`

Create a phase or milestone in an Aha! release.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the release milestone. |
| `end_on` | string | No | Milestone end date in YYYY-MM-DD format. |
| `progress` | string | No | Completed progress; valid only when progress_source is progress_manual. |
| `start_on` | string | No | Milestone start date in YYYY-MM-DD format. |
| `phase_type` | string ("phase" | "milestone") | Yes | Release phase type: phase or milestone. |
| `release_id` | string | Yes | ID of the release that will contain the milestone. |
| `description` | string | No | Description of the release milestone; HTML is accepted. |
| `duration_source` | string ("duration_manual" | "duration_from_features") | No | Method used to calculate milestone dates. |
| `progress_source` | string ("progress_manual" | "progress_from_features" | "progress_from_features_with_dependents" | "progress_from_todos" | "progress_from_todos_with_dependents" | "progress_from_features_completed" | "progress_from_features_completed_with_dependents") | No | Method used to calculate milestone progress. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Requirement

**Slug:** `AHA_CREATE_REQUIREMENT`

Create a requirement within one feature.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Name of the requirement. |
| `end_date` | string | No | Planned end date in YYYY-MM-DD format. |
| `feature_id` | string | Yes | Feature ID or reference number in which to create the requirement. |
| `start_date` | string | No | Planned start date in YYYY-MM-DD format. |
| `description` | string | No | Requirement description, which may contain HTML. |
| `workflow_status` | object | No | Workflow status, identified by name or ID. |
| `assigned_to_user` | object | No | Assigned user, identified by email. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create To-Do

**Slug:** `AHA_CREATE_TODO`

Create a standalone personal to-do for the connected Aha! user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | Yes | Detailed description for the to-do. |
| `name` | string | Yes | Short name for the new personal to-do. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Create Workflow Status Time

**Slug:** `AHA_CREATE_WORKFLOW_STATUS_TIME`

Create a workflow status interval for one supported parent record. This endpoint requires activation by Aha! support.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `parent_id` | string | Yes | ID of the parent record. |
| `parent_type` | string ("epic" | "feature" | "idea" | "initiative" | "key_result" | "release" | "requirement") | Yes | Type of parent record whose status interval to create. |
| `workflow_status_time` | object | Yes | Workflow status interval to create. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Custom Field Option

**Slug:** `AHA_DELETE_CUSTOM_FIELD_OPTION`

Delete one option from an Aha! custom-field definition; it may remain restorable through the recycle bin for up to 30 days.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `option_id` | string | Yes | Numeric ID of the custom-field option to delete. |
| `custom_field_definition_id` | string | Yes | Numeric ID of the custom-field definition. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Epic

**Slug:** `AHA_DELETE_EPIC`

Delete an epic by ID; it may remain restorable through the recycle bin for up to 30 days.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `epic_id` | string | Yes | Epic ID to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Feature

**Slug:** `AHA_DELETE_FEATURE`

Delete one feature by ID or reference number; it may remain restorable through the recycle bin for up to 30 days.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `feature_id` | string | Yes | Feature ID or reference number to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Goal

**Slug:** `AHA_DELETE_GOAL`

Delete one strategic goal; it may remain restorable through the recycle bin for up to 30 days.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `goal_id` | string | Yes | Goal ID to delete. |
| `product_id` | string | Yes | Workspace or product-line ID or reference prefix. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Idea

**Slug:** `AHA_DELETE_IDEA`

Delete an idea by ID or reference key; it may remain restorable through the recycle bin for up to 30 days.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `idea_id` | string | Yes | Numeric ID or reference key of the idea to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Idea Theme

**Slug:** `AHA_DELETE_IDEA_THEME`

Delete an idea theme by numeric ID; it may remain restorable through the recycle bin for up to 30 days.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `idea_theme_id` | string | Yes | Numeric ID of the idea theme to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Initiative

**Slug:** `AHA_DELETE_INITIATIVE`

Delete one strategic initiative; it may remain restorable through the recycle bin for up to 30 days.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `product_id` | string | Yes | Workspace or product-line ID or reference prefix. |
| `initiative_id` | string | Yes | Initiative ID to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Key Result

**Slug:** `AHA_DELETE_KEY_RESULT`

Delete one key result; it may remain restorable through the recycle bin for up to 30 days.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `key_result_id` | string | Yes | Key-result ID to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Release

**Slug:** `AHA_DELETE_RELEASE`

Delete a release from a workspace; it may remain restorable through the recycle bin for up to 30 days.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `product_id` | string | Yes | Workspace ID containing the release. |
| `release_id` | string | Yes | Release ID to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Release Phase

**Slug:** `AHA_DELETE_RELEASE_PHASE`

Delete a release phase by numeric ID; it may remain restorable through the recycle bin for up to 30 days.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `release_phase_id` | string | Yes | Numeric ID of the release phase to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Requirement

**Slug:** `AHA_DELETE_REQUIREMENT`

Delete one requirement by ID or reference number; it may remain restorable through the recycle bin for up to 30 days.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `requirement_id` | string | Yes | Requirement ID or reference number to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete To-Do

**Slug:** `AHA_DELETE_TODO`

Delete one to-do by its Aha! task ID; it may remain restorable through the recycle bin for up to 30 days.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `todo_id` | string | Yes | Aha! task ID to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete User Custom Role

**Slug:** `AHA_DELETE_USER_CUSTOM_ROLE`

Remove a user's custom role in one Aha! product.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | Yes | Numeric ID of the user. |
| `product_id` | string | Yes | Numeric ID of the product whose custom role to remove. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete User Product Role

**Slug:** `AHA_DELETE_USER_PRODUCT_ROLE`

Remove a user's role in one Aha! product.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | Yes | Numeric ID of the user. |
| `product_id` | string | Yes | Numeric ID of the product whose role to remove. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Delete Workflow Status Time

**Slug:** `AHA_DELETE_WORKFLOW_STATUS_TIME`

Delete a workflow status interval. This endpoint requires activation by Aha! support.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workflow_status_time_id` | string | Yes | Numeric ID of the workflow status interval to delete. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Duplicate Release

**Slug:** `AHA_DUPLICATE_RELEASE`

Create a duplicate of an existing release.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `release_id` | string | Yes | Release ID to duplicate. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Current User

**Slug:** `AHA_GET_CURRENT_USER`

Return the connected Aha! user, account context, and product roles.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Custom Layout

**Slug:** `AHA_GET_CUSTOM_LAYOUT`

Return one custom layout. Requires configuration-administrator access.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `custom_layout_id` | string | Yes | Unique custom-layout ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Epic

**Slug:** `AHA_GET_EPIC`

Return one Aha! epic by its ID or reference number.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `epic_id` | string | Yes | Aha! epic ID or reference number. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Feature

**Slug:** `AHA_GET_FEATURE`

Return detailed information for one feature by internal ID or human-readable reference number.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated response fields to request; omit for the standard detailed shape. |
| `feature_id` | string | Yes | Feature internal ID or human-readable reference number. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Goal

**Slug:** `AHA_GET_GOAL`

Return one strategic goal by ID or reference number.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `goal_id` | string | Yes | Aha! goal ID or documented reference number. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Idea

**Slug:** `AHA_GET_IDEA`

Return one idea by ID or reference number.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated response fields to request; omit for the standard detailed shape. |
| `idea_id` | string | Yes | Aha! idea ID or documented reference number. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Idea Theme

**Slug:** `AHA_GET_IDEA_THEME`

Return one idea theme by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `idea_theme_id` | string | Yes | Aha! idea theme ID or documented reference number. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Identity Provider

**Slug:** `AHA_GET_IDENTITY_PROVIDER`

Return one identity provider configured for account SSO.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `identity_provider_id` | string | Yes | Unique identity-provider ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Initiative

**Slug:** `AHA_GET_INITIATIVE`

Return one strategic initiative by ID or reference number.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `initiative_id` | string | Yes | Aha! initiative ID or documented reference number. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Key Result

**Slug:** `AHA_GET_KEY_RESULT`

Return one key result by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `key_result_id` | string | Yes | Aha! key result ID or documented reference number. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Release

**Slug:** `AHA_GET_RELEASE`

Return one release by ID or reference number.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `release_id` | string | Yes | Aha! release ID or documented reference number. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Release Phase

**Slug:** `AHA_GET_RELEASE_PHASE`

Return one release phase by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `release_phase_id` | string | Yes | Aha! release phase ID or documented reference number. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Requirement

**Slug:** `AHA_GET_REQUIREMENT`

Return one requirement by ID or reference number.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `requirement_id` | string | Yes | Aha! requirement ID or documented reference number. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Roll-Up Release

**Slug:** `AHA_GET_ROLLUP_RELEASE`

Return one roll-up release by ID or reference number.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `rollup_release_id` | string | Yes | Roll-up release numeric ID or reference number. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Strategic Model

**Slug:** `AHA_GET_STRATEGIC_MODEL`

Return one strategic model by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `strategic_model_id` | string | Yes | Unique strategic-model ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Strategic Vision

**Slug:** `AHA_GET_STRATEGIC_VISION`

Return one strategic vision by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `strategic_vision_id` | string | Yes | Unique strategic-vision ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get To-Do

**Slug:** `AHA_GET_TODO`

Return one to-do by its Aha! task ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated response fields to request; omit for the standard detailed shape. |
| `todo_id` | string | Yes | Aha! task ID returned by create or list to-dos. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get User

**Slug:** `AHA_GET_USER`

Get a specific Aha! user by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | Yes | Aha! user ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Workflow

**Slug:** `AHA_GET_WORKFLOW`

Return one workflow with its statuses and workflow kinds.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workflow_id` | string | Yes | Unique workflow ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Workflow Status Time

**Slug:** `AHA_GET_WORKFLOW_STATUS_TIME`

Return one workflow status interval. The endpoint must be enabled by Aha! support.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workflow_status_time_id` | string | Yes | Unique workflow-status-time ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Workspace

**Slug:** `AHA_GET_WORKSPACE`

Return one workspace and its applied template by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `fields` | string | No | Comma-separated response fields to request; omit for the standard detailed shape. |
| `workspace_id` | string | Yes | Aha! workspace ID or documented reference number. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List All Custom Field Options

**Slug:** `AHA_LIST_ALL_CUSTOM_FIELD_OPTIONS`

Return all options configured for one custom-field definition.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `custom_field_definition_id` | string | Yes | Custom-field definition ID whose options to return. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Assigned Records

**Slug:** `AHA_LIST_ASSIGNED_RECORDS`

List one page of records assigned to the connected Aha! user, optionally by record type.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Cursor from the previous page; omit initially. |
| `per_page` | integer | No | Maximum assigned records to return on this page. |
| `record_type` | string | No | Optional Aha! record type to return. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Assistant Usage

**Slug:** `AHA_LIST_ASSISTANT_USAGE`

Return one page of per-user AI assistant activity. The first page requires both start_at and end_at; subsequent pages accept the returned cursor alone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Page cursor returned by the previous call; omit for the first page. |
| `end_at` | string | No | Required with start_at on the first page. End of the usage window as an ISO 8601 timestamp; must be after start_at. |
| `per_page` | integer | No | Maximum records to return on this page (1-200). |
| `start_at` | string | No | Required with end_at on the first page. Start of the usage window as an ISO 8601 timestamp. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Audits

**Slug:** `AHA_LIST_AUDITS`

Return one page of immutable Aha! record-change history, optionally filtered by the changed record or an associated parent record.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Page cursor returned by the previous call; omit for the first page. |
| `fields` | string | No | Comma-separated audit response fields to request. |
| `per_page` | integer | No | Maximum records to return on this page (1-200). |
| `auditable_id` | string | No | ID of the changed record to filter by. |
| `associated_id` | string | No | ID of an associated parent record to filter by. |
| `auditable_type` | string | No | Aha! record type to filter by, such as Feature or task. |
| `associated_type` | string | No | Aha! type of the associated parent record. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Child Releases

**Slug:** `AHA_LIST_CHILD_RELEASES`

Return releases under a roll-up release, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Cursor from the previous call; omit for the first page. |
| `per_page` | integer | No | Maximum releases to return on this page (1-200). |
| `release_id` | string | Yes | Roll-up release ID whose child releases to return. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Custom Field Options

**Slug:** `AHA_LIST_CUSTOM_FIELD_OPTIONS`

Return selectable options for one custom-field definition.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `custom_field_definition_id` | string | Yes | Custom-field definition ID whose selectable options to return. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Custom Fields

**Slug:** `AHA_LIST_CUSTOM_FIELDS`

Return custom-field definitions, keys, types, and worksheet metadata.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Custom Layouts

**Slug:** `AHA_LIST_CUSTOM_LAYOUTS`

Return custom layouts configured in the account.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Deletions

**Slug:** `AHA_LIST_DELETIONS`

Return records currently visible in the account recycle bin, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Continuation cursor returned by the previous call; omit for the first page. |
| `per_page` | integer | No | Maximum records to return on this page (1-200). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Epics

**Slug:** `AHA_LIST_EPICS`

Return one page of epics across the account or within a goal, initiative, release, or workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Page cursor returned by the previous call; omit for the first page. |
| `fields` | string | No | Comma-separated response fields to request; omit for the standard epic shape. |
| `per_page` | integer | No | Maximum records to return on this page (1-200). |
| `context_id` | string | No | Goal, initiative, release, or workspace ID required by contextual routes. |
| `context_type` | string ("account" | "goal" | "initiative" | "release" | "workspace") | No | Route context: account, goal, initiative, release, or workspace. |
| `custom_fields` | string | No | JSON object of custom-field key-value pairs for account-wide filtering. All pairs must match. |
| `workflow_status` | string | No | Exact workflow status name used to filter epics. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Features

**Slug:** `AHA_LIST_FEATURES`

Return one page of features across the account or within a goal, initiative, epic, workspace, or release.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Page cursor returned by the previous call; omit for the first page. |
| `fields` | string | No | Comma-separated response fields to request; omit for the standard feature shape. |
| `per_page` | integer | No | Maximum records to return on this page (1-200). |
| `context_id` | string | No | Goal, initiative, epic, workspace, or release ID required by contextual routes. |
| `context_type` | string ("account" | "goal" | "initiative" | "epic" | "workspace" | "release") | No | Route context: account, goal, initiative, epic, workspace, or release. |
| `custom_fields` | string | No | JSON object of custom-field key-value pairs for account-wide filtering. All pairs must match. |
| `workflow_status` | string | No | Exact workflow status name used to filter features. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Goals

**Slug:** `AHA_LIST_GOALS`

Return one page of strategic goals across the account or within an initiative or product.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Page cursor returned by the previous call; omit for the first page. |
| `per_page` | integer | No | Maximum records to return on this page (1-200). |
| `context_id` | string | No | Initiative or product ID required by contextual routes. |
| `context_type` | string ("account" | "initiative" | "product") | No | Route context: account, initiative, or product. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Idea Portals

**Slug:** `AHA_LIST_IDEA_PORTALS`

Return idea portals configured in the account or linked to one product, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Page cursor returned by the previous call; omit for the first page. |
| `context` | string ("account" | "product") | No | Whether to list account-wide or product-linked portals. |
| `per_page` | integer | No | Maximum records to return on this page (1-200). |
| `product_id` | string | No | Product numeric ID or key. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Ideas

**Slug:** `AHA_LIST_IDEAS`

Search and filter ideas across the account or within one product, returning one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `tag` | string | No | Tag used to filter ideas. |
| `sort` | string ("recent" | "trending" | "popular") | No | Order ideas; the provider defaults to trending. |
| `spam` | string | No | Set to true to return ideas marked as spam. |
| `query` | string | No | Text to search for in ideas. |
| `cursor` | string | No | Page cursor returned by the previous call; omit for the first page. |
| `fields` | string | No | Comma-separated response fields to request; omit for the standard idea shape. |
| `context` | string ("account" | "product") | No | Whether to list account-wide or product-specific ideas. |
| `user_id` | string | No | Filter ideas by the creator's Aha! user ID. |
| `per_page` | integer | No | Maximum records to return on this page (1-200). |
| `product_id` | string | No | Product numeric ID or key. |
| `created_since` | string | No | Return ideas created at or after this ISO 8601 timestamp. |
| `updated_since` | string | No | Return ideas updated at or after this ISO 8601 timestamp. |
| `created_before` | string | No | Return ideas created before this ISO 8601 timestamp. |
| `workflow_status` | string | No | Exact workflow status name used to filter ideas. |
| `assigned_to_user` | string | No | User email used to filter assigned ideas. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Idea Themes

**Slug:** `AHA_LIST_IDEA_THEMES`

Return idea themes across the account, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Page cursor returned by the previous call; omit for the first page. |
| `per_page` | integer | No | Maximum records to return on this page (1-200). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Identity Providers

**Slug:** `AHA_LIST_IDENTITY_PROVIDERS`

Return active identity providers available for account SSO.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Initiatives

**Slug:** `AHA_LIST_INITIATIVES`

Return one page of strategic initiatives across the account or within a goal or product.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Page cursor returned by the previous call; omit for the first page. |
| `fields` | string | No | Comma-separated response fields to request; omit for the standard initiative shape. |
| `per_page` | integer | No | Maximum records to return on this page (1-200). |
| `context_id` | string | No | Goal or product ID required by contextual routes. |
| `context_type` | string ("account" | "goal" | "product") | No | Route context: account, goal, or product. |
| `custom_fields` | string | No | JSON object of custom-field key-value pairs for account-wide filtering. All pairs must match. |
| `workflow_status` | string | No | Exact workflow status name used to filter initiatives. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Key Results

**Slug:** `AHA_LIST_KEY_RESULTS`

Return key results for one strategic goal, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Page cursor returned by the previous call; omit for the first page. |
| `goal_id` | string | Yes | Goal ID or reference number whose key results to return. |
| `per_page` | integer | No | Maximum records to return on this page (1-200). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List My Pending To-Dos

**Slug:** `AHA_LIST_MY_PENDING_TODOS`

Deprecated compatibility action that lists one page of pending to-dos assigned to the connected Aha! user.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Cursor from the previous page; omit initially. |
| `per_page` | integer | No | Maximum pending to-dos to return on this page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Product Roll-Up Releases

**Slug:** `AHA_LIST_PRODUCT_ROLLUP_RELEASES`

Return roll-up releases in one Aha! product line, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Cursor from the previous call; omit for the first page. |
| `per_page` | integer | No | Maximum roll-up releases to return on this page (1-200). |
| `product_line_id` | string | Yes | Product-line numeric ID or key. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Product Users

**Slug:** `AHA_LIST_PRODUCT_USERS`

List one page of users and roles associated with an Aha! product.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Cursor from the previous page; omit initially. |
| `per_page` | integer | No | Maximum users to return on this page. |
| `product_id` | string | Yes | Aha! product ID or reference prefix. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Related Ideas

**Slug:** `AHA_LIST_RELATED_IDEAS`

Find ideas related to a term, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `query` | string | No | Text to match against idea names, descriptions, or IDs. |
| `cursor` | string | No | Page cursor returned by the previous call; omit for the first page. |
| `idea_portal_id` | string | No | Numeric idea portal ID within which to search. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Release Phases

**Slug:** `AHA_LIST_RELEASE_PHASES`

Return release phases across the account or within one release, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `type` | string ("phase" | "milestone") | No | For a release, limit results to phases or milestones. |
| `cursor` | string | No | Page cursor returned by the previous call; omit for the first page. |
| `context` | string ("account" | "release") | No | Whether to list account-wide or release-specific phases. |
| `per_page` | integer | No | Maximum records to return on this page (1-200). |
| `release_id` | string | No | Release numeric ID or key. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Releases

**Slug:** `AHA_LIST_RELEASES`

Return releases associated with a workspace, goal, or initiative, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Page cursor returned by the previous call; omit for the first page. |
| `per_page` | integer | No | Maximum records to return on this page (1-200). |
| `context_id` | string | No | Workspace, goal, or initiative ID. |
| `context_type` | string ("workspace" | "goal" | "initiative") | No | Resource whose associated releases to return. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Requirements

**Slug:** `AHA_LIST_REQUIREMENTS`

Return requirements for one feature, optionally updated since a timestamp, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Page cursor returned by the previous call; omit for the first page. |
| `per_page` | integer | No | Maximum records to return on this page (1-200). |
| `feature_id` | string | Yes | Feature ID or reference number whose requirements to return. |
| `updated_since` | string | No | Return requirements updated at or after this ISO 8601 timestamp. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Roll-Up Child Releases

**Slug:** `AHA_LIST_ROLLUP_CHILD_RELEASES`

Return releases under a roll-up release, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Cursor from the previous call; omit for the first page. |
| `per_page` | integer | No | Maximum releases to return on this page (1-200). |
| `release_id` | string | Yes | Roll-up release ID whose child releases to return. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Strategy Models

**Slug:** `AHA_LIST_STRATEGY_MODELS`

Return strategy models configured in the account, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Page cursor returned by the previous call; omit for the first page. |
| `per_page` | integer | No | Maximum records to return on this page (1-200). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Strategy Visions

**Slug:** `AHA_LIST_STRATEGY_VISIONS`

Return strategic vision records in the account, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Page cursor returned by the previous call; omit for the first page. |
| `per_page` | integer | No | Maximum records to return on this page (1-200). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List To-Dos

**Slug:** `AHA_LIST_TODOS`

Return one page of account, assigned-user, or associated-record to-dos.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `view` | string ("account" | "assigned_user" | "associated_record") | No | To-dos to list: all account to-dos, one user's assigned to-dos, or to-dos associated with a record. |
| `cursor` | string | No | Page cursor returned by the previous call; omit for the first page. |
| `fields` | string | No | Comma-separated response fields to request; omit for the standard to-do shape. |
| `epic_id` | string | No | Legacy epic selector; use parent_type and parent_id. |
| `idea_id` | string | No | Legacy idea selector; use parent_type and parent_id. |
| `user_id` | string | No | Aha! user ID; required only when view is assigned_user. |
| `per_page` | integer | No | Maximum records to return on this page (1-200). |
| `parent_id` | string | No | Associated record ID or reference number; required only when view is associated_record. |
| `todo_type` | string | No | Aha! to-do type to return, such as Approval. |
| `feature_id` | string | No | Legacy feature selector; use parent_type and parent_id. |
| `product_id` | string | No | Legacy product selector; use parent_type and parent_id. |
| `release_id` | string | No | Legacy release selector; use parent_type and parent_id. |
| `parent_type` | string ("epic" | "feature" | "idea" | "product" | "release" | "requirement") | No | Associated record type; required only when view is associated_record. |
| `updated_since` | string | No | Return to-dos updated at or after this ISO 8601 timestamp. |
| `requirement_id` | string | No | Legacy requirement selector; use parent_type and parent_id. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List User Custom Roles

**Slug:** `AHA_LIST_USER_CUSTOM_ROLES`

List one page of an Aha! user's custom roles and their scopes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Cursor from the previous page; omit initially. |
| `user_id` | string | Yes | Aha! user ID. |
| `per_page` | integer | No | Maximum roles to return on this page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List User Product Roles

**Slug:** `AHA_LIST_USER_PRODUCT_ROLES`

List one page of an Aha! user's roles in individual products.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Cursor from the previous page; omit initially. |
| `user_id` | string | Yes | Aha! user ID. |
| `per_page` | integer | No | Maximum roles to return on this page. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Users

**Slug:** `AHA_LIST_USERS`

Return account users and their seat and administrator flags, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Page cursor returned by the previous call; omit for the first page. |
| `per_page` | integer | No | Maximum records to return on this page (1-200). |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Workflows

**Slug:** `AHA_LIST_WORKFLOWS`

Return workflows and statuses configured for one workspace.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workspace_id` | string | Yes | Workspace ID whose workflows to return. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Workflow Status Times

**Slug:** `AHA_LIST_WORKFLOW_STATUS_TIMES`

Return workflow status intervals for one supported parent record, one page at a time. The endpoint must be enabled by Aha! support.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Cursor from the previous call. |
| `per_page` | integer | No | Maximum intervals to return (1-200). |
| `parent_id` | string | Yes | ID of the parent record. |
| `parent_type` | string ("epic" | "feature" | "idea" | "initiative" | "key_result" | "release" | "requirement") | Yes | Type of parent record whose status intervals to return. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Workspaces

**Slug:** `AHA_LIST_WORKSPACES`

Return Aha! workspaces and workspace lines available to the connected user, one page at a time.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `cursor` | string | No | Page cursor returned by the previous call; omit for the first page. |
| `per_page` | integer | No | Maximum records to return on this page (1-200). |
| `include_teams` | boolean | No | Include Aha! Develop teams in the results. |
| `with_idea_portals` | boolean | No | Return only workspaces linked to idea portals. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Promote Idea

**Slug:** `AHA_PROMOTE_IDEA`

Promote an idea to an epic, feature, initiative, or requirement.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `idea_id` | string | Yes | Numeric ID or reference key of the idea to promote. |
| `feature_id` | string | No | Feature ID or key; required for requirement promotion. |
| `product_id` | string | No | Product ID or key; required for initiative promotion. |
| `release_id` | string | No | Release ID or key; required for feature or epic promotion. |
| `promotable_type` | string ("epic" | "feature" | "initiative" | "requirement") | Yes | Record type to create from the idea. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Replace Product Idea Portals

**Slug:** `AHA_REPLACE_PRODUCT_IDEA_PORTALS`

Replace every idea portal link on a product.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `product_id` | string | Yes | Numeric ID or key of the product. |
| `idea_portal_ids` | array | Yes | Complete set of idea portal IDs to link; use an empty array to unlink all portals. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Restore Deleted Record

**Slug:** `AHA_RESTORE_DELETED_RECORD`

Start restoring a record from the recycle bin within its retention period; restoration may continue asynchronously.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `deletion_id` | string | Yes | Deletion ID of the recycle-bin record to restore. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Custom Field Option

**Slug:** `AHA_UPDATE_CUSTOM_FIELD_OPTION`

Update the value, color, or visibility of a custom-field option.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `color` | integer | No | Base-10 representation of the option's hexadecimal RGB color. |
| `value` | string | No | New value of the custom-field option. |
| `hidden` | boolean | No | Whether the option should be hidden. |
| `option_id` | string | Yes | Numeric ID of the custom-field option to update. |
| `custom_field_definition_id` | string | Yes | Numeric ID of the custom-field definition. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Epic

**Slug:** `AHA_UPDATE_EPIC`

Update an epic by ID; provide at least one field to change.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Replacement epic name. |
| `tags` | string | No | Replacement comma-separated tags. |
| `goals` | array | No | Complete replacement list of associated goal names or IDs. |
| `epic_id` | string | Yes | Epic ID to update. |
| `release` | string | No | Release ID or key to which the epic should move. |
| `due_date` | string | No | Due date in YYYY-MM-DD format. |
| `initiative` | string | No | Replacement initiative name or ID. |
| `start_date` | string | No | Start date in YYYY-MM-DD format. |
| `description` | string | No | Replacement epic description; HTML is accepted. |
| `duration_source` | string ("duration_manual" | "duration_from_features" | "duration_from_releases") | No | Method used to calculate epic dates. |
| `workflow_status` | string | No | Replacement workflow status name. |
| `assigned_to_user` | string | No | Replacement assignee email address. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Feature

**Slug:** `AHA_UPDATE_FEATURE`

Update one feature's planning fields; provide at least one field to change.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `epic` | string | No | Epic name or ID. |
| `name` | string | No | Replacement feature name. |
| `tags` | string | No | Replacement comma-separated tags. |
| `team` | string | No | Replacement team ID or key. |
| `goals` | array | No | Complete replacement list of associated goal names or IDs. |
| `release` | string | No | New release ID or key. |
| `due_date` | string | No | Due date in YYYY-MM-DD format. |
| `progress` | string | No | Completion progress when progress_source is progress_manual. |
| `iteration` | string | No | Replacement sprint or iteration ID. |
| `created_by` | string | No | Creator email address. |
| `feature_id` | string | Yes | Feature ID or reference number to update. |
| `initiative` | string | No | Initiative name or ID. |
| `start_date` | string | No | Start date in YYYY-MM-DD format. |
| `description` | string | No | Replacement HTML description. |
| `release_phase` | string | No | Release phase name or ID. |
| `workflow_kind` | string | No | Feature workflow-kind identifier configured for the release's workspace (for example, new); use AHA_LIST_WORKFLOWS to discover available values. |
| `progress_source` | string ("progress_manual" | "progress_from_requirements" | "progress_from_requirements_with_dependents" | "progress_from_remaining_estimate" | "progress_from_remaining_estimate_with_dependents" | "progress_from_todos" | "progress_from_todos_with_dependents") | No | Replacement method for calculating feature progress. |
| `workflow_status` | object | No | New workflow status. |
| `assigned_to_user` | object | No | New assignee by email. |
| `initial_estimate` | string | No | Replacement initial estimate in configured capacity units. |
| `detailed_estimate` | string | No | Replacement detailed estimate in configured capacity units. |
| `program_increment` | string | No | Replacement program increment ID or key. |
| `remaining_estimate` | string | No | Replacement remaining estimate in configured capacity units. |
| `team_workflow_status` | string | No | Replacement status valid for the selected team. |
| `initial_estimate_text` | string | No | Replacement initial estimate using time units or story points. |
| `detailed_estimate_text` | string | No | Replacement detailed estimate using time units or story points. |
| `remaining_estimate_text` | string | No | Replacement remaining estimate using time units or story points. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Goal

**Slug:** `AHA_UPDATE_GOAL`

Update one strategic goal; provide at least one field to change.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Replacement goal name. |
| `value` | integer | No | Replacement value score from 1 to 100. |
| `effort` | integer | No | Replacement effort score from 1 to 100. |
| `goal_id` | string | Yes | Goal ID to update. |
| `progress` | number | No | Manual completion percentage. |
| `watchers` | array | No | Complete replacement watcher ID list. |
| `parent_id` | string | No | Replacement parent goal ID. |
| `product_id` | string | Yes | Workspace or product-line ID or reference prefix. |
| `time_frame` | object | No | Replacement strategic time frame. |
| `description` | string | No | Replacement description; HTML is accepted. |
| `custom_fields` | array | No | Custom-field updates. |
| `success_metric` | object | No | Success-metric updates. |
| `progress_source` | string ("progress_manual" | "progress_from_features" | "progress_from_features_with_dependents" | "progress_from_releases" | "progress_from_releases_with_dependents" | "progress_from_initiatives" | "progress_from_initiatives_with_dependents" | "progress_from_descendants" | "progress_from_descendants_with_dependents" | "progress_from_features_completed" | "progress_from_features_completed_with_dependents" | "progress_from_epics" | "progress_from_epics_with_dependents" | "progress_from_key_results" | "progress_from_key_results_with_dependents") | No | Progress source: progress_manual, progress_from_features, progress_from_features_with_dependents, progress_from_releases, progress_from_releases_with_dependents, progress_from_initiatives, progress_from_initiatives_with_dependents, progress_from_descendants, progress_from_descendants_with_dependents, progress_from_features_completed, progress_from_features_completed_with_dependents, progress_from_epics, progress_from_epics_with_dependents, progress_from_key_results, or progress_from_key_results_with_dependents. |
| `workflow_status` | string | No | Replacement workflow status name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Idea

**Slug:** `AHA_UPDATE_IDEA`

Update an existing idea; provide at least one field to change.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `epic` | string | No | Name or ID of the promoted epic. |
| `name` | string | No | New idea name. |
| `spam` | boolean | No | Whether the idea is spam. |
| `tags` | string | No | Comma-separated tags for the idea. |
| `themes` | string | No | Comma-separated numeric idea theme IDs. |
| `feature` | string | No | Name or ID of the promoted feature. |
| `idea_id` | string | Yes | Numeric ID or reference key of the idea to update. |
| `categories` | string | No | Comma-separated existing category names for the idea. |
| `created_at` | string | No | Idea creation date in UTC as YYYY-MM-DD or YYYY-MM-DD HH:MM:SS. |
| `created_by` | string | No | Email address of the user who created the idea. |
| `initiative` | string | No | Name or ID of the promoted initiative. |
| `visibility` | string ("aha" | "creator" | "employee" | "employee_or_creator" | "creator_organization" | "public") | No | Idea visibility. |
| `description` | string | No | New idea description, which may contain HTML. |
| `initial_votes` | integer | No | Vote count to seed when importing the idea. |
| `duplicate_idea` | string | No | Idea ID or key to merge this idea into; use an empty value to unmerge it. |
| `workflow_status` | string | No | Valid workflow status ID or name for the idea's product. |
| `assigned_to_user` | string | No | Email address of the user assigned to the idea. |
| `portal_restricted` | boolean | No | Whether the idea is restricted to specific portals. |
| `submitted_idea_portal_id` | string | No | Numeric ID of the idea portal through which the idea was submitted. |
| `restricted_idea_portal_ids` | array | No | Portal IDs allowed to access the restricted idea. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Idea Theme

**Slug:** `AHA_UPDATE_IDEA_THEME`

Update an idea theme; provide a new name or description.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New idea theme name. |
| `idea_theme_id` | string | Yes | Numeric ID of the idea theme to update. |
| `description_attributes` | object | No | New rich-text description attributes for the theme. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Initiative

**Slug:** `AHA_UPDATE_INITIATIVE`

Update one strategic initiative; provide at least one field to change.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Replacement initiative name. |
| `goals` | array | No | Complete associated goal ID or name list. |
| `value` | string | No | Replacement business value. |
| `effort` | string | No | Replacement effort value. |
| `end_date` | string | No | Replacement end date in YYYY-MM-DD format. |
| `position` | integer | No | Replacement ordering position. |
| `progress` | number | No | Manual completion percentage. |
| `watchers` | array | No | Complete replacement watcher ID list. |
| `parent_id` | string | No | Replacement parent initiative ID. |
| `presented` | boolean | No | Whether to show the initiative on charts. |
| `product_id` | string | Yes | Workspace or product-line ID or reference prefix. |
| `start_date` | string | No | Replacement start date in YYYY-MM-DD format. |
| `time_frame` | object | No | Replacement time frame by ID or name. |
| `description` | string | No | Replacement description; HTML is accepted. |
| `custom_fields` | array | No | Custom-field updates. |
| `initiative_id` | string | Yes | Initiative ID to update. |
| `duration_source` | string ("duration_manual" | "duration_from_children" | "duration_from_releases" | "duration_from_features_epics") | No | Duration source: duration_manual, duration_from_children, duration_from_releases, or duration_from_features_epics. |
| `progress_source` | string ("progress_manual" | "progress_from_features" | "progress_from_features_with_dependents" | "progress_from_releases" | "progress_from_releases_with_dependents" | "progress_from_children" | "progress_from_children_with_dependents" | "progress_from_features_completed" | "progress_from_features_completed_with_dependents" | "progress_from_epics" | "progress_from_epics_with_dependents") | No | Progress source: progress_manual, progress_from_features, progress_from_features_with_dependents, progress_from_releases, progress_from_releases_with_dependents, progress_from_children, progress_from_children_with_dependents, progress_from_features_completed, progress_from_features_completed_with_dependents, progress_from_epics, or progress_from_epics_with_dependents. |
| `workflow_status` | string | No | Replacement status by ID or name. |
| `assigned_to_user` | string | No | Assigned user's email address. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Key Result

**Slug:** `AHA_UPDATE_KEY_RESULT`

Update one key result; provide at least one field to change.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Replacement key-result name. |
| `watchers` | array | No | Complete replacement watcher ID list. |
| `description` | string | No | Replacement description; HTML is accepted. |
| `custom_fields` | array | No | Custom-field updates. |
| `key_result_id` | string | Yes | Key-result ID to update. |
| `target_metric` | string | No | Replacement target metric. |
| `current_metric` | string | No | Replacement current metric. |
| `starting_metric` | string | No | Replacement starting metric. |
| `workflow_status` | object | No | Replacement workflow status by name. |
| `assigned_to_user` | object | No | Replacement assignee by email. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Product

**Slug:** `AHA_UPDATE_PRODUCT`

Update an Aha! product; provide a new name, description, or reference prefix.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New product name. |
| `product_id` | string | Yes | ID or reference prefix of the Aha! product to update. |
| `description` | string | No | New product description. |
| `reference_prefix` | string | No | New reference prefix for the product. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Release

**Slug:** `AHA_UPDATE_RELEASE`

Update a release by ID, optionally through a specified workspace, including dates, capacity, progress, parent, owner, goals, and initiatives; provide at least one field to change.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Replacement release name. |
| `goals` | array | No | Complete replacement list of associated goal names or IDs. |
| `owner` | string | No | Replacement owner email address or ID. |
| `theme` | string | No | Replacement release theme; HTML is accepted. |
| `end_date` | string | No | End date in YYYY-MM-DD format. |
| `progress` | string | No | Completion percentage; valid when progress_source is progress_manual. |
| `parent_id` | string | No | Replacement parent roll-up release ID. |
| `release_id` | string | Yes | Release numeric ID or key to update. |
| `start_date` | string | No | Start date in YYYY-MM-DD format. |
| `initiatives` | array | No | Complete replacement list of associated initiative names or IDs. |
| `parking_lot` | boolean | No | Whether the release is a parking-lot release. |
| `release_date` | string | No | Release date in YYYY-MM-DD format. |
| `workspace_id` | string | No | Workspace numeric ID or key; when provided, use the workspace-nested route. |
| `capacity_units` | string ("time" | "story_points") | No | Replacement capacity units. |
| `duration_source` | string ("duration_manual" | "duration_from_release_phases_features" | "duration_from_sub_releases") | No | Source used to calculate release dates. |
| `progress_source` | string ("progress_manual" | "progress_from_features" | "progress_from_features_with_dependents" | "progress_from_release_phases" | "progress_from_release_phases_with_dependents" | "progress_from_todos" | "progress_from_todos_with_dependents" | "progress_from_remaining_estimate" | "progress_from_remaining_estimate_with_dependents" | "progress_from_features_completed" | "progress_from_features_completed_with_dependents" | "progress_from_epics" | "progress_from_epics_with_dependents" | "progress_from_sub_releases") | No | Source Aha! uses to calculate release progress. |
| `workflow_status` | string | No | Replacement workflow status name. |
| `total_capacity_text` | string | No | Total capacity expressed in the configured capacity units. |
| `external_release_date` | string | No | External release date in YYYY-MM-DD format. |
| `development_started_on` | string | No | Date development started in YYYY-MM-DD format. |
| `external_date_resolution` | string ("sync" | "exact" | "week" | "month" | "quarter" | "half" | "year") | No | Resolution for the external release date. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Release Phase

**Slug:** `AHA_UPDATE_RELEASE_PHASE`

Update a release phase's type, dates, description, or progress.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end_on` | string | No | Updated end date in YYYY-MM-DD format. |
| `progress` | string | No | Completed progress; valid only when progress_source is progress_manual. |
| `start_on` | string | No | Updated start date in YYYY-MM-DD format. |
| `phase_type` | string ("phase" | "milestone") | Yes | Release phase type: phase or milestone. |
| `description` | string | No | Updated release phase description; HTML is accepted. |
| `duration_source` | string ("duration_manual" | "duration_from_features") | No | Method used to calculate release phase dates. |
| `progress_source` | string ("progress_manual" | "progress_from_features" | "progress_from_features_with_dependents" | "progress_from_todos" | "progress_from_todos_with_dependents" | "progress_from_features_completed" | "progress_from_features_completed_with_dependents") | No | Method used to calculate release phase progress. |
| `release_phase_id` | string | Yes | Numeric ID of the release phase to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Requirement

**Slug:** `AHA_UPDATE_REQUIREMENT`

Update one requirement; provide at least one field to change.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Replacement name. |
| `end_date` | string | No | Replacement end date in YYYY-MM-DD format. |
| `start_date` | string | No | Replacement start date in YYYY-MM-DD format. |
| `description` | string | No | Replacement description, which may contain HTML. |
| `requirement_id` | string | Yes | Requirement ID or reference number to update. |
| `workflow_status` | object | No | New workflow status, identified by name or ID. |
| `assigned_to_user` | object | No | New assigned user, identified by email. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Roll-Up Release

**Slug:** `AHA_UPDATE_ROLLUP_RELEASE`

Update a roll-up release or add workspaces to it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Replacement roll-up release name. |
| `project_ids` | array | No | Workspace IDs or keys to add to the roll-up release. |
| `rollup_release_id` | string | Yes | Roll-up release numeric ID or reference number. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update To-Do

**Slug:** `AHA_UPDATE_TODO`

Update an existing to-do's name or description; provide at least one of name or body.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `body` | string | No | Replacement detailed description for the to-do; omit to leave it unchanged. At least one of name or body is required. |
| `name` | string | No | Replacement name for the to-do; omit to leave it unchanged. At least one of name or body is required. |
| `todo_id` | string | Yes | Aha! task ID to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update User

**Slug:** `AHA_UPDATE_USER`

Update an Aha! user; provide a new name or enabled state.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `enabled` | boolean | No | Whether the user can access Aha!. |
| `user_id` | string | Yes | Aha! user ID. |
| `last_name` | string | No | New last name. |
| `first_name` | string | No | New first name. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update User Custom Roles

**Slug:** `AHA_UPDATE_USER_CUSTOM_ROLES`

Assign a custom role to an Aha! user for one product.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `user_id` | string | Yes | Numeric ID of the user. |
| `product_id` | string | Yes | Numeric ID of the product where the custom role applies. |
| `custom_role_id` | string | Yes | Numeric ID of the custom role to assign. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update User Product Roles

**Slug:** `AHA_UPDATE_USER_PRODUCT_ROLES`

Assign a product role to an Aha! user for one product.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `role` | string ("product_owner" | "contributor" | "reviewer" | "viewer" | "none") | Yes | Product role to assign: product_owner, contributor, reviewer, viewer, or none. |
| `user_id` | string | Yes | Numeric ID of the user. |
| `product_id` | string | Yes | Numeric ID or key of the product where the role applies. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Update Workflow Status Time

**Slug:** `AHA_UPDATE_WORKFLOW_STATUS_TIME`

Update a workflow status interval. This endpoint requires activation by Aha! support.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `workflow_status_time` | object | Yes | Workflow status interval fields to update. |
| `workflow_status_time_id` | string | Yes | Numeric ID of the workflow status interval to update. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |