> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Aha!

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

![Aha! logo](https://mintcdn.com/composio-preview/qzegrvAapILigeDI/images/toolkits/aha.svg?fit=max\&auto=format\&n=qzegrvAapILigeDI\&q=85\&s=df74b90a9eb3537b187090ece333f6ff)

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

## Tools

> [accordion] Add Product Idea Portals
>
> **Slug:** `AHA_ADD_PRODUCT_IDEA_PORTALS`
>
> Add idea portal links to a product without replacing existing links.
>
> #### Input Parameters
>
> **product\_id** `string` *required*
>
> Numeric ID or key of the product.
>
> **idea\_portal\_ids** `array` *required*
>
> Idea portal IDs to add without removing existing links.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **feature\_id** `string` *required*
>
> Feature ID or reference number to convert into an epic.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Convert Requirement to Feature
>
> **Slug:** `AHA_CONVERT_REQUIREMENT_TO_FEATURE`
>
> Irreversibly convert an existing requirement into a feature.
>
> #### Input Parameters
>
> **requirement\_id** `string` *required*
>
> Requirement ID or reference number to convert into a feature.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Custom Field Option
>
> **Slug:** `AHA_CREATE_CUSTOM_FIELD_OPTION`
>
> Create an option for one custom-field definition.
>
> #### Input Parameters
>
> **color** `integer`
>
> Base-10 representation of the option's hexadecimal RGB color.
>
> **value** `string` *required*
>
> Value displayed for the new option.
>
> **custom\_field\_definition\_id** `string` *required*
>
> Custom-field definition ID that will own the option.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Epic
>
> **Slug:** `AHA_CREATE_EPIC`
>
> Create an epic in a release or in a workspace's default release.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Name of the epic.
>
> **tags** `string`
>
> Comma-separated tags to add to the epic.
>
> **goals** `array`
>
> Goal names or IDs to associate with the epic.
>
> **due\_date** `string`
>
> Due date in YYYY-MM-DD format.
>
> **created\_by** `string`
>
> Email address of the user creating the epic.
>
> **initiative** `string`
>
> Initiative name or ID to associate with the epic.
>
> **start\_date** `string`
>
> Start date in YYYY-MM-DD format.
>
> **description** `string`
>
> Epic description; HTML is accepted.
>
> **destination\_id** `string` *required*
>
> Release ID or workspace ID selected by destination\_type.
>
> **duration\_source** `string ("duration_manual" | "duration_from_features" | "duration_from_releases")`
>
> Method used to calculate epic dates.
>
> **workflow\_status** `string`
>
> Workflow status name valid for the workspace.
>
> **assigned\_to\_user** `string`
>
> Email address of the user assigned to the epic.
>
> **destination\_type** `string ("release" | "workspace_default_release")` *required*
>
> Whether to create the epic in a release or a workspace's default release.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Feature
>
> **Slug:** `AHA_CREATE_FEATURE`
>
> Create a feature in a release with its documented planning fields.
>
> #### Input Parameters
>
> **epic** `string`
>
> Epic name or ID.
>
> **name** `string` *required*
>
> Name of the feature.
>
> **tags** `string`
>
> Comma-separated tags to add to the feature.
>
> **team** `string`
>
> Team ID or key.
>
> **goals** `array`
>
> Goal names or IDs to associate with the feature.
>
> **release** `string`
>
> Release ID or key to assign to the feature.
>
> **due\_date** `string`
>
> Due date in YYYY-MM-DD format.
>
> **progress** `string`
>
> Completion progress when progress\_source is progress\_manual.
>
> **iteration** `string`
>
> Sprint ID.
>
> **created\_by** `string`
>
> Email address of the user who created the feature.
>
> **initiative** `string`
>
> Initiative name or ID.
>
> **release\_id** `string` *required*
>
> Release ID or reference number in which to create the feature.
>
> **start\_date** `string`
>
> Start date in YYYY-MM-DD format.
>
> **description** `string`
>
> Feature description, which may contain HTML.
>
> **release\_phase** `string`
>
> Release phase name or ID.
>
> **workflow\_kind** `string`
>
> 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")`
>
> Method used to calculate feature progress.
>
> **workflow\_status** `object`
>
> Workflow status, identified by name or ID.
>
> **assigned\_to\_user** `object`
>
> Assigned user, identified by email.
>
> **initial\_estimate** `string`
>
> Initial estimate in the workspace's configured capacity units.
>
> **detailed\_estimate** `string`
>
> Detailed estimate in the workspace's configured capacity units.
>
> **program\_increment** `string`
>
> Program increment ID or key.
>
> **remaining\_estimate** `string`
>
> Remaining estimate in the workspace's configured capacity units.
>
> **team\_workflow\_status** `string`
>
> Valid team status.
>
> **initial\_estimate\_text** `string`
>
> Initial estimate using time units (for example, 2d 1h) or story points (for example, 4p).
>
> **detailed\_estimate\_text** `string`
>
> Detailed estimate using time units or story points.
>
> **remaining\_estimate\_text** `string`
>
> Remaining estimate using time units or story points.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Goal
>
> **Slug:** `AHA_CREATE_GOAL`
>
> Create a strategic goal in one Aha! workspace or product line.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Name of the new goal.
>
> **value** `integer`
>
> Value score from 1 to 100.
>
> **effort** `integer`
>
> Effort score from 1 to 100.
>
> **progress** `number`
>
> Manual completion percentage from 0 to 100.
>
> **watchers** `array`
>
> Aha! user IDs to add as goal watchers.
>
> **parent\_id** `string`
>
> Parent goal ID, when this goal rolls up.
>
> **product\_id** `string` *required*
>
> Workspace or product-line ID or reference prefix.
>
> **time\_frame** `object`
>
> Strategic time frame selected by ID or name.
>
> **description** `string`
>
> Goal description; HTML is accepted.
>
> **custom\_fields** `array`
>
> Custom-field values to set on the goal.
>
> **success\_metric** `object` *required*
>
> 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")`
>
> 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`
>
> Goal workflow status name.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Idea
>
> **Slug:** `AHA_CREATE_IDEA`
>
> Create an idea in a product with the documented idea fields.
>
> #### Input Parameters
>
> **epic** `string`
>
> Name or ID of a promoted epic.
>
> **name** `string` *required*
>
> Name of the idea.
>
> **spam** `boolean`
>
> Whether the idea is spam.
>
> **tags** `string`
>
> Comma-separated tags for the idea.
>
> **themes** `string`
>
> Comma-separated numeric idea theme IDs.
>
> **feature** `string`
>
> Name or ID of a promoted feature.
>
> **categories** `string`
>
> Comma-separated existing category names.
>
> **created\_at** `string`
>
> Creation date in UTC as YYYY-MM-DD or YYYY-MM-DD HH:MM:SS.
>
> **created\_by** `string`
>
> Email address of the user who created the idea.
>
> **initiative** `string`
>
> Name or ID of a promoted initiative.
>
> **product\_id** `string` *required*
>
> Numeric ID or key of the product.
>
> **visibility** `string ("aha" | "creator" | "employee" | "employee_or_creator" | "creator_organization" | "public")`
>
> Initial idea visibility; defaults to aha.
>
> **description** `string`
>
> Idea description, which may contain HTML.
>
> **initial\_votes** `integer`
>
> Vote count to seed when importing the idea.
>
> **duplicate\_idea** `string`
>
> ID or key of an idea that this idea duplicates.
>
> **workflow\_status** `string`
>
> Valid workflow status ID or name for the product.
>
> **assigned\_to\_user** `string`
>
> Email address of the user assigned to the idea.
>
> **portal\_restricted** `boolean`
>
> Whether the idea is restricted to specific portals.
>
> **submitted\_idea\_portal\_id** `string`
>
> Numeric idea portal ID through which the idea is submitted.
>
> **restricted\_idea\_portal\_ids** `array`
>
> Portal IDs allowed to access the restricted idea.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Idea Theme
>
> **Slug:** `AHA_CREATE_IDEA_THEME`
>
> Create an idea theme in a product.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Name of the idea theme.
>
> **product\_id** `string` *required*
>
> Numeric ID or key of the product that will contain the theme.
>
> **description\_attributes** `object`
>
> Rich-text description attributes for the theme.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Initiative
>
> **Slug:** `AHA_CREATE_INITIATIVE`
>
> Create a strategic initiative in one Aha! workspace or product line.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Name of the new initiative.
>
> **goals** `array`
>
> Associated goal IDs or names.
>
> **value** `string`
>
> Business value of the initiative.
>
> **effort** `string`
>
> Effort required for the initiative.
>
> **end\_date** `string`
>
> End date in YYYY-MM-DD format.
>
> **position** `integer`
>
> Initiative ordering position.
>
> **progress** `number`
>
> Manual completion percentage.
>
> **watchers** `array`
>
> Aha! user IDs to add as watchers.
>
> **parent\_id** `string`
>
> Parent initiative ID.
>
> **presented** `boolean`
>
> Whether to show the initiative on charts.
>
> **product\_id** `string` *required*
>
> Workspace or product-line ID or reference prefix.
>
> **start\_date** `string`
>
> Start date in YYYY-MM-DD format.
>
> **time\_frame** `object`
>
> Strategic time frame by ID or name.
>
> **description** `string`
>
> Initiative description; HTML is accepted.
>
> **custom\_fields** `array`
>
> Custom-field values.
>
> **duration\_source** `string ("duration_manual" | "duration_from_children" | "duration_from_releases" | "duration_from_features_epics")`
>
> 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")`
>
> 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` *required*
>
> Initial workflow status by ID or name.
>
> **assigned\_to\_user** `string`
>
> Email address of the assigned Aha! user.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Key Result
>
> **Slug:** `AHA_CREATE_KEY_RESULT`
>
> Create a key result under one strategic goal.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Name of the new key result.
>
> **goal\_id** `string` *required*
>
> Goal ID or reference number.
>
> **watchers** `array`
>
> Aha! user IDs to add as watchers.
>
> **description** `string`
>
> Key-result description; HTML is accepted.
>
> **custom\_fields** `array`
>
> Custom-field values.
>
> **target\_metric** `string`
>
> Target metric value.
>
> **current\_metric** `string`
>
> Current metric value.
>
> **starting\_metric** `string`
>
> Starting metric value.
>
> **workflow\_status** `object`
>
> Initial workflow status by name.
>
> **assigned\_to\_user** `object`
>
> User assigned by email address.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Parking-Lot Release
>
> **Slug:** `AHA_CREATE_PARKING_LOT_RELEASE`
>
> Create a parking-lot release in a workspace.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Name of the parking-lot release.
>
> **goals** `array`
>
> Goal names or IDs to associate with the release.
>
> **owner** `string`
>
> Email address or ID of the release owner.
>
> **theme** `string`
>
> Release theme; HTML is accepted.
>
> **end\_date** `string`
>
> End date in YYYY-MM-DD format.
>
> **parent\_id** `string`
>
> ID of the parent roll-up release.
>
> **product\_id** `string` *required*
>
> Workspace ID in which to create the release.
>
> **start\_date** `string`
>
> Start date in YYYY-MM-DD format.
>
> **initiatives** `array`
>
> Initiative names or IDs to associate with the release.
>
> **capacity\_units** `string ("time" | "story_points")`
>
> Capacity units used by the release.
>
> **workflow\_status** `string`
>
> Workflow status name valid for the workspace.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Product
>
> **Slug:** `AHA_CREATE_PRODUCT`
>
> Create an Aha! product workspace with a name, description, and reference prefix.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Name of the new Aha! workspace.
>
> **prefix** `string` *required*
>
> Reference prefix for records in the workspace.
>
> **description** `string`
>
> Description of the new workspace.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Product Contributor
>
> **Slug:** `AHA_CREATE_PRODUCT_CONTRIBUTOR`
>
> Create an Aha! contributor user associated with a product.
>
> #### Input Parameters
>
> **role** `string`
>
> Product role for the new user.
>
> **email** `string` *required*
>
> Email address for the new user.
>
> **last\_name** `string` *required*
>
> New user's last name.
>
> **first\_name** `string` *required*
>
> New user's first name.
>
> **product\_id** `string` *required*
>
> Aha! product ID or reference prefix.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **name** `string` *required*
>
> Name of the new roll-up release.
>
> **theme** `string`
>
> Roll-up release theme; HTML is accepted.
>
> **product\_id** `string` *required*
>
> Product-line numeric ID or key.
>
> **project\_ids** `array`
>
> Workspace IDs or keys to add to the roll-up release.
>
> **release\_date** `string`
>
> Roll-up release date in YYYY-MM-DD format.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Release Milestone
>
> **Slug:** `AHA_CREATE_RELEASE_MILESTONE`
>
> Create a phase or milestone in an Aha! release.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Name of the release milestone.
>
> **end\_on** `string`
>
> Milestone end date in YYYY-MM-DD format.
>
> **progress** `string`
>
> Completed progress; valid only when progress\_source is progress\_manual.
>
> **start\_on** `string`
>
> Milestone start date in YYYY-MM-DD format.
>
> **phase\_type** `string ("phase" | "milestone")` *required*
>
> Release phase type: phase or milestone.
>
> **release\_id** `string` *required*
>
> ID of the release that will contain the milestone.
>
> **description** `string`
>
> Description of the release milestone; HTML is accepted.
>
> **duration\_source** `string ("duration_manual" | "duration_from_features")`
>
> 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")`
>
> Method used to calculate milestone progress.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Requirement
>
> **Slug:** `AHA_CREATE_REQUIREMENT`
>
> Create a requirement within one feature.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Name of the requirement.
>
> **end\_date** `string`
>
> Planned end date in YYYY-MM-DD format.
>
> **feature\_id** `string` *required*
>
> Feature ID or reference number in which to create the requirement.
>
> **start\_date** `string`
>
> Planned start date in YYYY-MM-DD format.
>
> **description** `string`
>
> Requirement description, which may contain HTML.
>
> **workflow\_status** `object`
>
> Workflow status, identified by name or ID.
>
> **assigned\_to\_user** `object`
>
> Assigned user, identified by email.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create To-Do
>
> **Slug:** `AHA_CREATE_TODO`
>
> Create a standalone personal to-do for the connected Aha! user.
>
> #### Input Parameters
>
> **body** `string` *required*
>
> Detailed description for the to-do.
>
> **name** `string` *required*
>
> Short name for the new personal to-do.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **parent\_id** `string` *required*
>
> ID of the parent record.
>
> **parent\_type** `string ("epic" | "feature" | "idea" | "initiative" | "key_result" | "release" | "requirement")` *required*
>
> Type of parent record whose status interval to create.
>
> **workflow\_status\_time** `object` *required*
>
> Workflow status interval to create.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **option\_id** `string` *required*
>
> Numeric ID of the custom-field option to delete.
>
> **custom\_field\_definition\_id** `string` *required*
>
> Numeric ID of the custom-field definition.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **epic\_id** `string` *required*
>
> Epic ID to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **feature\_id** `string` *required*
>
> Feature ID or reference number to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **goal\_id** `string` *required*
>
> Goal ID to delete.
>
> **product\_id** `string` *required*
>
> Workspace or product-line ID or reference prefix.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **idea\_id** `string` *required*
>
> Numeric ID or reference key of the idea to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **idea\_theme\_id** `string` *required*
>
> Numeric ID of the idea theme to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **product\_id** `string` *required*
>
> Workspace or product-line ID or reference prefix.
>
> **initiative\_id** `string` *required*
>
> Initiative ID to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **key\_result\_id** `string` *required*
>
> Key-result ID to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **product\_id** `string` *required*
>
> Workspace ID containing the release.
>
> **release\_id** `string` *required*
>
> Release ID to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **release\_phase\_id** `string` *required*
>
> Numeric ID of the release phase to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **requirement\_id** `string` *required*
>
> Requirement ID or reference number to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **todo\_id** `string` *required*
>
> Aha! task ID to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete User Custom Role
>
> **Slug:** `AHA_DELETE_USER_CUSTOM_ROLE`
>
> Remove a user's custom role in one Aha! product.
>
> #### Input Parameters
>
> **user\_id** `string` *required*
>
> Numeric ID of the user.
>
> **product\_id** `string` *required*
>
> Numeric ID of the product whose custom role to remove.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete User Product Role
>
> **Slug:** `AHA_DELETE_USER_PRODUCT_ROLE`
>
> Remove a user's role in one Aha! product.
>
> #### Input Parameters
>
> **user\_id** `string` *required*
>
> Numeric ID of the user.
>
> **product\_id** `string` *required*
>
> Numeric ID of the product whose role to remove.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Workflow Status Time
>
> **Slug:** `AHA_DELETE_WORKFLOW_STATUS_TIME`
>
> Delete a workflow status interval. This endpoint requires activation by Aha! support.
>
> #### Input Parameters
>
> **workflow\_status\_time\_id** `string` *required*
>
> Numeric ID of the workflow status interval to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Duplicate Release
>
> **Slug:** `AHA_DUPLICATE_RELEASE`
>
> Create a duplicate of an existing release.
>
> #### Input Parameters
>
> **release\_id** `string` *required*
>
> Release ID to duplicate.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Current User
>
> **Slug:** `AHA_GET_CURRENT_USER`
>
> Return the connected Aha! user, account context, and product roles.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Custom Layout
>
> **Slug:** `AHA_GET_CUSTOM_LAYOUT`
>
> Return one custom layout. Requires configuration-administrator access.
>
> #### Input Parameters
>
> **custom\_layout\_id** `string` *required*
>
> Unique custom-layout ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Epic
>
> **Slug:** `AHA_GET_EPIC`
>
> Return one Aha! epic by its ID or reference number.
>
> #### Input Parameters
>
> **epic\_id** `string` *required*
>
> Aha! epic ID or reference number.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Feature
>
> **Slug:** `AHA_GET_FEATURE`
>
> Return detailed information for one feature by internal ID or human-readable reference number.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated response fields to request; omit for the standard detailed shape.
>
> **feature\_id** `string` *required*
>
> Feature internal ID or human-readable reference number.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Goal
>
> **Slug:** `AHA_GET_GOAL`
>
> Return one strategic goal by ID or reference number.
>
> #### Input Parameters
>
> **goal\_id** `string` *required*
>
> Aha! goal ID or documented reference number.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Idea
>
> **Slug:** `AHA_GET_IDEA`
>
> Return one idea by ID or reference number.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated response fields to request; omit for the standard detailed shape.
>
> **idea\_id** `string` *required*
>
> Aha! idea ID or documented reference number.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Idea Theme
>
> **Slug:** `AHA_GET_IDEA_THEME`
>
> Return one idea theme by ID.
>
> #### Input Parameters
>
> **idea\_theme\_id** `string` *required*
>
> Aha! idea theme ID or documented reference number.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Identity Provider
>
> **Slug:** `AHA_GET_IDENTITY_PROVIDER`
>
> Return one identity provider configured for account SSO.
>
> #### Input Parameters
>
> **identity\_provider\_id** `string` *required*
>
> Unique identity-provider ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Initiative
>
> **Slug:** `AHA_GET_INITIATIVE`
>
> Return one strategic initiative by ID or reference number.
>
> #### Input Parameters
>
> **initiative\_id** `string` *required*
>
> Aha! initiative ID or documented reference number.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Key Result
>
> **Slug:** `AHA_GET_KEY_RESULT`
>
> Return one key result by ID.
>
> #### Input Parameters
>
> **key\_result\_id** `string` *required*
>
> Aha! key result ID or documented reference number.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Release
>
> **Slug:** `AHA_GET_RELEASE`
>
> Return one release by ID or reference number.
>
> #### Input Parameters
>
> **release\_id** `string` *required*
>
> Aha! release ID or documented reference number.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Release Phase
>
> **Slug:** `AHA_GET_RELEASE_PHASE`
>
> Return one release phase by ID.
>
> #### Input Parameters
>
> **release\_phase\_id** `string` *required*
>
> Aha! release phase ID or documented reference number.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Requirement
>
> **Slug:** `AHA_GET_REQUIREMENT`
>
> Return one requirement by ID or reference number.
>
> #### Input Parameters
>
> **requirement\_id** `string` *required*
>
> Aha! requirement ID or documented reference number.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Roll-Up Release
>
> **Slug:** `AHA_GET_ROLLUP_RELEASE`
>
> Return one roll-up release by ID or reference number.
>
> #### Input Parameters
>
> **rollup\_release\_id** `string` *required*
>
> Roll-up release numeric ID or reference number.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Strategic Model
>
> **Slug:** `AHA_GET_STRATEGIC_MODEL`
>
> Return one strategic model by ID.
>
> #### Input Parameters
>
> **strategic\_model\_id** `string` *required*
>
> Unique strategic-model ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Strategic Vision
>
> **Slug:** `AHA_GET_STRATEGIC_VISION`
>
> Return one strategic vision by ID.
>
> #### Input Parameters
>
> **strategic\_vision\_id** `string` *required*
>
> Unique strategic-vision ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get To-Do
>
> **Slug:** `AHA_GET_TODO`
>
> Return one to-do by its Aha! task ID.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated response fields to request; omit for the standard detailed shape.
>
> **todo\_id** `string` *required*
>
> Aha! task ID returned by create or list to-dos.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get User
>
> **Slug:** `AHA_GET_USER`
>
> Get a specific Aha! user by ID.
>
> #### Input Parameters
>
> **user\_id** `string` *required*
>
> Aha! user ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Workflow
>
> **Slug:** `AHA_GET_WORKFLOW`
>
> Return one workflow with its statuses and workflow kinds.
>
> #### Input Parameters
>
> **workflow\_id** `string` *required*
>
> Unique workflow ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **workflow\_status\_time\_id** `string` *required*
>
> Unique workflow-status-time ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Workspace
>
> **Slug:** `AHA_GET_WORKSPACE`
>
> Return one workspace by ID, with applied template details when available or requested.
>
> #### Input Parameters
>
> **fields** `string`
>
> Comma-separated response fields to request; omit for the standard detailed shape.
>
> **workspace\_id** `string` *required*
>
> Aha! workspace ID or documented reference number.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List All Custom Field Options
>
> **Slug:** `AHA_LIST_ALL_CUSTOM_FIELD_OPTIONS`
>
> Return all options configured for one custom-field definition.
>
> #### Input Parameters
>
> **custom\_field\_definition\_id** `string` *required*
>
> Custom-field definition ID whose options to return.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **cursor** `string`
>
> Cursor from the previous page; omit initially.
>
> **per\_page** `integer`
>
> Maximum assigned records to return on this page.
>
> **record\_type** `string`
>
> Optional Aha! record type to return.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **cursor** `string`
>
> Page cursor returned by the previous call; omit for the first page.
>
> **end\_at** `string`
>
> 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`
>
> Maximum records to return on this page (1-200).
>
> **start\_at** `string`
>
> Required with end\_at on the first page. Start of the usage window as an ISO 8601 timestamp.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **cursor** `string`
>
> Page cursor returned by the previous call; omit for the first page.
>
> **fields** `string`
>
> Comma-separated audit response fields to request.
>
> **per\_page** `integer`
>
> Maximum records to return on this page (1-200).
>
> **auditable\_id** `string`
>
> ID of the changed record to filter by.
>
> **associated\_id** `string`
>
> ID of an associated parent record to filter by.
>
> **auditable\_type** `string`
>
> Aha! record type to filter by, such as Feature or task.
>
> **associated\_type** `string`
>
> Aha! type of the associated parent record.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Child Releases
>
> **Slug:** `AHA_LIST_CHILD_RELEASES`
>
> Return releases under a roll-up release, one page at a time.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Cursor from the previous call; omit for the first page.
>
> **per\_page** `integer`
>
> Maximum releases to return on this page (1-200).
>
> **release\_id** `string` *required*
>
> Roll-up release ID whose child releases to return.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Custom Field Options
>
> **Slug:** `AHA_LIST_CUSTOM_FIELD_OPTIONS`
>
> Return selectable options for one custom-field definition.
>
> #### Input Parameters
>
> **custom\_field\_definition\_id** `string` *required*
>
> Custom-field definition ID whose selectable options to return.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Custom Fields
>
> **Slug:** `AHA_LIST_CUSTOM_FIELDS`
>
> Return custom-field definitions, keys, types, and worksheet metadata.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Custom Layouts
>
> **Slug:** `AHA_LIST_CUSTOM_LAYOUTS`
>
> Return custom layouts configured in the account.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Deletions
>
> **Slug:** `AHA_LIST_DELETIONS`
>
> Return records currently visible in the account recycle bin, one page at a time.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Continuation cursor returned by the previous call; omit for the first page.
>
> **per\_page** `integer`
>
> Maximum records to return on this page (1-200).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Epics
>
> **Slug:** `AHA_LIST_EPICS`
>
> Return one page of epics across the account or within a goal, initiative, release, or workspace.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Page cursor returned by the previous call; omit for the first page.
>
> **fields** `string`
>
> Comma-separated response fields to request; omit for the standard epic shape.
>
> **per\_page** `integer`
>
> Maximum records to return on this page (1-200).
>
> **context\_id** `string`
>
> Goal, initiative, release, or workspace ID required by contextual routes.
>
> **context\_type** `string ("account" | "goal" | "initiative" | "release" | "workspace")`
>
> Route context: account, goal, initiative, release, or workspace.
>
> **custom\_fields** `string`
>
> JSON object of custom-field key-value pairs for account-wide filtering. All pairs must match.
>
> **workflow\_status** `string`
>
> Exact workflow status name used to filter epics.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **cursor** `string`
>
> Page cursor returned by the previous call; omit for the first page.
>
> **fields** `string`
>
> Comma-separated response fields to request; omit for the standard feature shape.
>
> **per\_page** `integer`
>
> Maximum records to return on this page (1-200).
>
> **context\_id** `string`
>
> Goal, initiative, epic, workspace, or release ID required by contextual routes.
>
> **context\_type** `string ("account" | "goal" | "initiative" | "epic" | "workspace" | "release")`
>
> Route context: account, goal, initiative, epic, workspace, or release.
>
> **custom\_fields** `string`
>
> JSON object of custom-field key-value pairs for account-wide filtering. All pairs must match.
>
> **workflow\_status** `string`
>
> Exact workflow status name used to filter features.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Goals
>
> **Slug:** `AHA_LIST_GOALS`
>
> Return one page of strategic goals across the account or within an initiative or product.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Page cursor returned by the previous call; omit for the first page.
>
> **per\_page** `integer`
>
> Maximum records to return on this page (1-200).
>
> **context\_id** `string`
>
> Initiative or product ID required by contextual routes.
>
> **context\_type** `string ("account" | "initiative" | "product")`
>
> Route context: account, initiative, or product.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **cursor** `string`
>
> Page cursor returned by the previous call; omit for the first page.
>
> **context** `string ("account" | "product")`
>
> Whether to list account-wide or product-linked portals.
>
> **per\_page** `integer`
>
> Maximum records to return on this page (1-200).
>
> **product\_id** `string`
>
> Product numeric ID or key.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **tag** `string`
>
> Tag used to filter ideas.
>
> **sort** `string ("recent" | "trending" | "popular")`
>
> Order ideas; the provider defaults to trending.
>
> **spam** `string`
>
> Set to true to return ideas marked as spam.
>
> **query** `string`
>
> Text to search for in ideas.
>
> **cursor** `string`
>
> Page cursor returned by the previous call; omit for the first page.
>
> **fields** `string`
>
> Comma-separated response fields to request; omit for the standard idea shape.
>
> **context** `string ("account" | "product")`
>
> Whether to list account-wide or product-specific ideas.
>
> **user\_id** `string`
>
> Filter ideas by the creator's Aha! user ID.
>
> **per\_page** `integer`
>
> Maximum records to return on this page (1-200).
>
> **product\_id** `string`
>
> Product numeric ID or key.
>
> **created\_since** `string`
>
> Return ideas created at or after this ISO 8601 timestamp.
>
> **updated\_since** `string`
>
> Return ideas updated at or after this ISO 8601 timestamp.
>
> **created\_before** `string`
>
> Return ideas created before this ISO 8601 timestamp.
>
> **workflow\_status** `string`
>
> Exact workflow status name used to filter ideas.
>
> **assigned\_to\_user** `string`
>
> User email used to filter assigned ideas.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Idea Themes
>
> **Slug:** `AHA_LIST_IDEA_THEMES`
>
> Return idea themes across the account, one page at a time.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Page cursor returned by the previous call; omit for the first page.
>
> **per\_page** `integer`
>
> Maximum records to return on this page (1-200).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Identity Providers
>
> **Slug:** `AHA_LIST_IDENTITY_PROVIDERS`
>
> Return active identity providers available for account SSO.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Initiatives
>
> **Slug:** `AHA_LIST_INITIATIVES`
>
> Return one page of strategic initiatives across the account or within a goal or product.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Page cursor returned by the previous call; omit for the first page.
>
> **fields** `string`
>
> Comma-separated response fields to request; omit for the standard initiative shape.
>
> **per\_page** `integer`
>
> Maximum records to return on this page (1-200).
>
> **context\_id** `string`
>
> Goal or product ID required by contextual routes.
>
> **context\_type** `string ("account" | "goal" | "product")`
>
> Route context: account, goal, or product.
>
> **custom\_fields** `string`
>
> JSON object of custom-field key-value pairs for account-wide filtering. All pairs must match.
>
> **workflow\_status** `string`
>
> Exact workflow status name used to filter initiatives.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Key Results
>
> **Slug:** `AHA_LIST_KEY_RESULTS`
>
> Return key results for one strategic goal, one page at a time.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Page cursor returned by the previous call; omit for the first page.
>
> **goal\_id** `string` *required*
>
> Goal ID or reference number whose key results to return.
>
> **per\_page** `integer`
>
> Maximum records to return on this page (1-200).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **cursor** `string`
>
> Cursor from the previous page; omit initially.
>
> **per\_page** `integer`
>
> Maximum pending to-dos to return on this page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **cursor** `string`
>
> Cursor from the previous call; omit for the first page.
>
> **per\_page** `integer`
>
> Maximum roll-up releases to return on this page (1-200).
>
> **product\_line\_id** `string` *required*
>
> Product-line numeric ID or key.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Product Users
>
> **Slug:** `AHA_LIST_PRODUCT_USERS`
>
> List one page of users and roles associated with an Aha! product.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Cursor from the previous page; omit initially.
>
> **per\_page** `integer`
>
> Maximum users to return on this page.
>
> **product\_id** `string` *required*
>
> Aha! product ID or reference prefix.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Related Ideas
>
> **Slug:** `AHA_LIST_RELATED_IDEAS`
>
> Find ideas related to a term, one page at a time.
>
> #### Input Parameters
>
> **query** `string`
>
> Text to match against idea names, descriptions, or IDs.
>
> **cursor** `string`
>
> Page cursor returned by the previous call; omit for the first page.
>
> **idea\_portal\_id** `string`
>
> Numeric idea portal ID within which to search.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **type** `string ("phase" | "milestone")`
>
> For a release, limit results to phases or milestones.
>
> **cursor** `string`
>
> Page cursor returned by the previous call; omit for the first page.
>
> **context** `string ("account" | "release")`
>
> Whether to list account-wide or release-specific phases.
>
> **per\_page** `integer`
>
> Maximum records to return on this page (1-200).
>
> **release\_id** `string`
>
> Release numeric ID or key.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Releases
>
> **Slug:** `AHA_LIST_RELEASES`
>
> Return releases associated with a workspace, goal, or initiative, one page at a time.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Page cursor returned by the previous call; omit for the first page.
>
> **per\_page** `integer`
>
> Maximum records to return on this page (1-200).
>
> **context\_id** `string`
>
> Workspace, goal, or initiative ID.
>
> **context\_type** `string ("workspace" | "goal" | "initiative")`
>
> Resource whose associated releases to return.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Requirements
>
> **Slug:** `AHA_LIST_REQUIREMENTS`
>
> Return requirements for one feature, optionally updated since a timestamp, one page at a time.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Page cursor returned by the previous call; omit for the first page.
>
> **per\_page** `integer`
>
> Maximum records to return on this page (1-200).
>
> **feature\_id** `string` *required*
>
> Feature ID or reference number whose requirements to return.
>
> **updated\_since** `string`
>
> Return requirements updated at or after this ISO 8601 timestamp.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **cursor** `string`
>
> Cursor from the previous call; omit for the first page.
>
> **per\_page** `integer`
>
> Maximum releases to return on this page (1-200).
>
> **release\_id** `string` *required*
>
> Roll-up release ID whose child releases to return.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Strategy Models
>
> **Slug:** `AHA_LIST_STRATEGY_MODELS`
>
> Return strategy models configured in the account, one page at a time.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Page cursor returned by the previous call; omit for the first page.
>
> **per\_page** `integer`
>
> Maximum records to return on this page (1-200).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Strategy Visions
>
> **Slug:** `AHA_LIST_STRATEGY_VISIONS`
>
> Return strategic vision records in the account, one page at a time.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Page cursor returned by the previous call; omit for the first page.
>
> **per\_page** `integer`
>
> Maximum records to return on this page (1-200).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List To-Dos
>
> **Slug:** `AHA_LIST_TODOS`
>
> Return one page of account, assigned-user, or associated-record to-dos.
>
> #### Input Parameters
>
> **view** `string ("account" | "assigned_user" | "associated_record")`
>
> To-dos to list: all account to-dos, one user's assigned to-dos, or to-dos associated with a record.
>
> **cursor** `string`
>
> Page cursor returned by the previous call; omit for the first page.
>
> **fields** `string`
>
> Comma-separated response fields to request; omit for the standard to-do shape.
>
> **epic\_id** `string`
>
> Legacy epic selector; use parent\_type and parent\_id.
>
> **idea\_id** `string`
>
> Legacy idea selector; use parent\_type and parent\_id.
>
> **user\_id** `string`
>
> Aha! user ID; required only when view is assigned\_user.
>
> **per\_page** `integer`
>
> Maximum records to return on this page (1-200).
>
> **parent\_id** `string`
>
> Associated record ID or reference number; required only when view is associated\_record.
>
> **todo\_type** `string`
>
> Aha! to-do type to return, such as Approval.
>
> **feature\_id** `string`
>
> Legacy feature selector; use parent\_type and parent\_id.
>
> **product\_id** `string`
>
> Legacy product selector; use parent\_type and parent\_id.
>
> **release\_id** `string`
>
> Legacy release selector; use parent\_type and parent\_id.
>
> **parent\_type** `string ("epic" | "feature" | "idea" | "product" | "release" | "requirement")`
>
> Associated record type; required only when view is associated\_record.
>
> **updated\_since** `string`
>
> Return to-dos updated at or after this ISO 8601 timestamp.
>
> **requirement\_id** `string`
>
> Legacy requirement selector; use parent\_type and parent\_id.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **cursor** `string`
>
> Cursor from the previous page; omit initially.
>
> **user\_id** `string` *required*
>
> Aha! user ID.
>
> **per\_page** `integer`
>
> Maximum roles to return on this page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List User Product Roles
>
> **Slug:** `AHA_LIST_USER_PRODUCT_ROLES`
>
> List one page of an Aha! user's roles in individual products.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Cursor from the previous page; omit initially.
>
> **user\_id** `string` *required*
>
> Aha! user ID.
>
> **per\_page** `integer`
>
> Maximum roles to return on this page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Users
>
> **Slug:** `AHA_LIST_USERS`
>
> Return account users and their seat and administrator flags, one page at a time.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Page cursor returned by the previous call; omit for the first page.
>
> **per\_page** `integer`
>
> Maximum records to return on this page (1-200).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Workflows
>
> **Slug:** `AHA_LIST_WORKFLOWS`
>
> Return workflows and statuses configured for one workspace.
>
> #### Input Parameters
>
> **workspace\_id** `string` *required*
>
> Workspace ID whose workflows to return.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **cursor** `string`
>
> Cursor from the previous call.
>
> **per\_page** `integer`
>
> Maximum intervals to return (1-200).
>
> **parent\_id** `string` *required*
>
> ID of the parent record.
>
> **parent\_type** `string ("epic" | "feature" | "idea" | "initiative" | "key_result" | "release" | "requirement")` *required*
>
> Type of parent record whose status intervals to return.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Workspaces
>
> **Slug:** `AHA_LIST_WORKSPACES`
>
> Return Aha! workspaces and workspace lines available to the connected user, one page at a time.
>
> #### Input Parameters
>
> **cursor** `string`
>
> Page cursor returned by the previous call; omit for the first page.
>
> **per\_page** `integer`
>
> Maximum records to return on this page (1-200).
>
> **include\_teams** `boolean`
>
> Include Aha! Develop teams in the results.
>
> **with\_idea\_portals** `boolean`
>
> Return only workspaces linked to idea portals.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Promote Idea
>
> **Slug:** `AHA_PROMOTE_IDEA`
>
> Promote an idea to an epic, feature, initiative, or requirement.
>
> #### Input Parameters
>
> **idea\_id** `string` *required*
>
> Numeric ID or reference key of the idea to promote.
>
> **feature\_id** `string`
>
> Feature ID or key; required for requirement promotion.
>
> **product\_id** `string`
>
> Product ID or key; required for initiative promotion.
>
> **release\_id** `string`
>
> Release ID or key; required for feature or epic promotion.
>
> **promotable\_type** `string ("epic" | "feature" | "initiative" | "requirement")` *required*
>
> Record type to create from the idea.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Replace Product Idea Portals
>
> **Slug:** `AHA_REPLACE_PRODUCT_IDEA_PORTALS`
>
> Replace every idea portal link on a product.
>
> #### Input Parameters
>
> **product\_id** `string` *required*
>
> Numeric ID or key of the product.
>
> **idea\_portal\_ids** `array` *required*
>
> Complete set of idea portal IDs to link; use an empty array to unlink all portals.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **deletion\_id** `string` *required*
>
> Deletion ID of the recycle-bin record to restore.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Custom Field Option
>
> **Slug:** `AHA_UPDATE_CUSTOM_FIELD_OPTION`
>
> Update the value, color, or visibility of a custom-field option.
>
> #### Input Parameters
>
> **color** `integer`
>
> Base-10 representation of the option's hexadecimal RGB color.
>
> **value** `string`
>
> New value of the custom-field option.
>
> **hidden** `boolean`
>
> Whether the option should be hidden.
>
> **option\_id** `string` *required*
>
> Numeric ID of the custom-field option to update.
>
> **custom\_field\_definition\_id** `string` *required*
>
> Numeric ID of the custom-field definition.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Epic
>
> **Slug:** `AHA_UPDATE_EPIC`
>
> Update an epic by ID; provide at least one field to change.
>
> #### Input Parameters
>
> **name** `string`
>
> Replacement epic name.
>
> **tags** `string`
>
> Replacement comma-separated tags.
>
> **goals** `array`
>
> Complete replacement list of associated goal names or IDs.
>
> **epic\_id** `string` *required*
>
> Epic ID to update.
>
> **release** `string`
>
> Release ID or key to which the epic should move.
>
> **due\_date** `string`
>
> Due date in YYYY-MM-DD format.
>
> **initiative** `string`
>
> Replacement initiative name or ID.
>
> **start\_date** `string`
>
> Start date in YYYY-MM-DD format.
>
> **description** `string`
>
> Replacement epic description; HTML is accepted.
>
> **duration\_source** `string ("duration_manual" | "duration_from_features" | "duration_from_releases")`
>
> Method used to calculate epic dates.
>
> **workflow\_status** `string`
>
> Replacement workflow status name.
>
> **assigned\_to\_user** `string`
>
> Replacement assignee email address.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Feature
>
> **Slug:** `AHA_UPDATE_FEATURE`
>
> Update one feature's planning fields; provide at least one field to change.
>
> #### Input Parameters
>
> **epic** `string`
>
> Epic name or ID.
>
> **name** `string`
>
> Replacement feature name.
>
> **tags** `string`
>
> Replacement comma-separated tags.
>
> **team** `string`
>
> Replacement team ID or key.
>
> **goals** `array`
>
> Complete replacement list of associated goal names or IDs.
>
> **release** `string`
>
> New release ID or key.
>
> **due\_date** `string`
>
> Due date in YYYY-MM-DD format.
>
> **progress** `string`
>
> Completion progress when progress\_source is progress\_manual.
>
> **iteration** `string`
>
> Replacement sprint or iteration ID.
>
> **created\_by** `string`
>
> Creator email address.
>
> **feature\_id** `string` *required*
>
> Feature ID or reference number to update.
>
> **initiative** `string`
>
> Initiative name or ID.
>
> **start\_date** `string`
>
> Start date in YYYY-MM-DD format.
>
> **description** `string`
>
> Replacement HTML description.
>
> **release\_phase** `string`
>
> Release phase name or ID.
>
> **workflow\_kind** `string`
>
> 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")`
>
> Replacement method for calculating feature progress.
>
> **workflow\_status** `object`
>
> New workflow status.
>
> **assigned\_to\_user** `object`
>
> New assignee by email.
>
> **initial\_estimate** `string`
>
> Replacement initial estimate in configured capacity units.
>
> **detailed\_estimate** `string`
>
> Replacement detailed estimate in configured capacity units.
>
> **program\_increment** `string`
>
> Replacement program increment ID or key.
>
> **remaining\_estimate** `string`
>
> Replacement remaining estimate in configured capacity units.
>
> **team\_workflow\_status** `string`
>
> Replacement status valid for the selected team.
>
> **initial\_estimate\_text** `string`
>
> Replacement initial estimate using time units or story points.
>
> **detailed\_estimate\_text** `string`
>
> Replacement detailed estimate using time units or story points.
>
> **remaining\_estimate\_text** `string`
>
> Replacement remaining estimate using time units or story points.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Goal
>
> **Slug:** `AHA_UPDATE_GOAL`
>
> Update one strategic goal; provide at least one field to change.
>
> #### Input Parameters
>
> **name** `string`
>
> Replacement goal name.
>
> **value** `integer`
>
> Replacement value score from 1 to 100.
>
> **effort** `integer`
>
> Replacement effort score from 1 to 100.
>
> **goal\_id** `string` *required*
>
> Goal ID to update.
>
> **progress** `number`
>
> Manual completion percentage.
>
> **watchers** `array`
>
> Complete replacement watcher ID list.
>
> **parent\_id** `string`
>
> Replacement parent goal ID.
>
> **product\_id** `string` *required*
>
> Workspace or product-line ID or reference prefix.
>
> **time\_frame** `object`
>
> Replacement strategic time frame.
>
> **description** `string`
>
> Replacement description; HTML is accepted.
>
> **custom\_fields** `array`
>
> Custom-field updates.
>
> **success\_metric** `object`
>
> 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")`
>
> 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`
>
> Replacement workflow status name.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Idea
>
> **Slug:** `AHA_UPDATE_IDEA`
>
> Update an existing idea; provide at least one field to change.
>
> #### Input Parameters
>
> **epic** `string`
>
> Name or ID of the promoted epic.
>
> **name** `string`
>
> New idea name.
>
> **spam** `boolean`
>
> Whether the idea is spam.
>
> **tags** `string`
>
> Comma-separated tags for the idea.
>
> **themes** `string`
>
> Comma-separated numeric idea theme IDs.
>
> **feature** `string`
>
> Name or ID of the promoted feature.
>
> **idea\_id** `string` *required*
>
> Numeric ID or reference key of the idea to update.
>
> **categories** `string`
>
> Comma-separated existing category names for the idea.
>
> **created\_at** `string`
>
> Idea creation date in UTC as YYYY-MM-DD or YYYY-MM-DD HH:MM:SS.
>
> **created\_by** `string`
>
> Email address of the user who created the idea.
>
> **initiative** `string`
>
> Name or ID of the promoted initiative.
>
> **visibility** `string ("aha" | "creator" | "employee" | "employee_or_creator" | "creator_organization" | "public")`
>
> Idea visibility.
>
> **description** `string`
>
> New idea description, which may contain HTML.
>
> **initial\_votes** `integer`
>
> Vote count to seed when importing the idea.
>
> **duplicate\_idea** `string`
>
> Idea ID or key to merge this idea into; use an empty value to unmerge it.
>
> **workflow\_status** `string`
>
> Valid workflow status ID or name for the idea's product.
>
> **assigned\_to\_user** `string`
>
> Email address of the user assigned to the idea.
>
> **portal\_restricted** `boolean`
>
> Whether the idea is restricted to specific portals.
>
> **submitted\_idea\_portal\_id** `string`
>
> Numeric ID of the idea portal through which the idea was submitted.
>
> **restricted\_idea\_portal\_ids** `array`
>
> Portal IDs allowed to access the restricted idea.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Idea Theme
>
> **Slug:** `AHA_UPDATE_IDEA_THEME`
>
> Update an idea theme; provide a new name or description.
>
> #### Input Parameters
>
> **name** `string`
>
> New idea theme name.
>
> **idea\_theme\_id** `string` *required*
>
> Numeric ID of the idea theme to update.
>
> **description\_attributes** `object`
>
> New rich-text description attributes for the theme.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Initiative
>
> **Slug:** `AHA_UPDATE_INITIATIVE`
>
> Update one strategic initiative; provide at least one field to change.
>
> #### Input Parameters
>
> **name** `string`
>
> Replacement initiative name.
>
> **goals** `array`
>
> Complete associated goal ID or name list.
>
> **value** `string`
>
> Replacement business value.
>
> **effort** `string`
>
> Replacement effort value.
>
> **end\_date** `string`
>
> Replacement end date in YYYY-MM-DD format.
>
> **position** `integer`
>
> Replacement ordering position.
>
> **progress** `number`
>
> Manual completion percentage.
>
> **watchers** `array`
>
> Complete replacement watcher ID list.
>
> **parent\_id** `string`
>
> Replacement parent initiative ID.
>
> **presented** `boolean`
>
> Whether to show the initiative on charts.
>
> **product\_id** `string` *required*
>
> Workspace or product-line ID or reference prefix.
>
> **start\_date** `string`
>
> Replacement start date in YYYY-MM-DD format.
>
> **time\_frame** `object`
>
> Replacement time frame by ID or name.
>
> **description** `string`
>
> Replacement description; HTML is accepted.
>
> **custom\_fields** `array`
>
> Custom-field updates.
>
> **initiative\_id** `string` *required*
>
> Initiative ID to update.
>
> **duration\_source** `string ("duration_manual" | "duration_from_children" | "duration_from_releases" | "duration_from_features_epics")`
>
> 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")`
>
> 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`
>
> Replacement status by ID or name.
>
> **assigned\_to\_user** `string`
>
> Assigned user's email address.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Key Result
>
> **Slug:** `AHA_UPDATE_KEY_RESULT`
>
> Update one key result; provide at least one field to change.
>
> #### Input Parameters
>
> **name** `string`
>
> Replacement key-result name.
>
> **watchers** `array`
>
> Complete replacement watcher ID list.
>
> **description** `string`
>
> Replacement description; HTML is accepted.
>
> **custom\_fields** `array`
>
> Custom-field updates.
>
> **key\_result\_id** `string` *required*
>
> Key-result ID to update.
>
> **target\_metric** `string`
>
> Replacement target metric.
>
> **current\_metric** `string`
>
> Replacement current metric.
>
> **starting\_metric** `string`
>
> Replacement starting metric.
>
> **workflow\_status** `object`
>
> Replacement workflow status by name.
>
> **assigned\_to\_user** `object`
>
> Replacement assignee by email.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Product
>
> **Slug:** `AHA_UPDATE_PRODUCT`
>
> Update an Aha! product; provide a new name, description, or reference prefix.
>
> #### Input Parameters
>
> **name** `string`
>
> New product name.
>
> **product\_id** `string` *required*
>
> ID or reference prefix of the Aha! product to update.
>
> **description** `string`
>
> New product description.
>
> **reference\_prefix** `string`
>
> New reference prefix for the product.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **name** `string`
>
> Replacement release name.
>
> **goals** `array`
>
> Complete replacement list of associated goal names or IDs.
>
> **owner** `string`
>
> Replacement owner email address or ID.
>
> **theme** `string`
>
> Replacement release theme; HTML is accepted.
>
> **end\_date** `string`
>
> End date in YYYY-MM-DD format.
>
> **progress** `string`
>
> Completion percentage; valid when progress\_source is progress\_manual.
>
> **parent\_id** `string`
>
> Replacement parent roll-up release ID.
>
> **release\_id** `string` *required*
>
> Release numeric ID or key to update.
>
> **start\_date** `string`
>
> Start date in YYYY-MM-DD format.
>
> **initiatives** `array`
>
> Complete replacement list of associated initiative names or IDs.
>
> **parking\_lot** `boolean`
>
> Whether the release is a parking-lot release.
>
> **release\_date** `string`
>
> Release date in YYYY-MM-DD format.
>
> **workspace\_id** `string`
>
> Workspace numeric ID or key; when provided, use the workspace-nested route.
>
> **capacity\_units** `string ("time" | "story_points")`
>
> Replacement capacity units.
>
> **duration\_source** `string ("duration_manual" | "duration_from_release_phases_features" | "duration_from_sub_releases")`
>
> 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")`
>
> Source Aha! uses to calculate release progress.
>
> **workflow\_status** `string`
>
> Replacement workflow status name.
>
> **total\_capacity\_text** `string`
>
> Total capacity expressed in the configured capacity units.
>
> **external\_release\_date** `string`
>
> External release date in YYYY-MM-DD format.
>
> **development\_started\_on** `string`
>
> Date development started in YYYY-MM-DD format.
>
> **external\_date\_resolution** `string ("sync" | "exact" | "week" | "month" | "quarter" | "half" | "year")`
>
> Resolution for the external release date.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Release Phase
>
> **Slug:** `AHA_UPDATE_RELEASE_PHASE`
>
> Update a release phase's type and optionally its dates, description, or progress. The phase type is required on every update.
>
> #### Input Parameters
>
> **end\_on** `string`
>
> Updated end date in YYYY-MM-DD format.
>
> **progress** `string`
>
> Completed progress; valid only when progress\_source is progress\_manual.
>
> **start\_on** `string`
>
> Updated start date in YYYY-MM-DD format.
>
> **phase\_type** `string ("phase" | "milestone")` *required*
>
> Release phase type: phase or milestone.
>
> **description** `string`
>
> Updated release phase description; HTML is accepted.
>
> **duration\_source** `string ("duration_manual" | "duration_from_features")`
>
> 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")`
>
> Method used to calculate release phase progress.
>
> **release\_phase\_id** `string` *required*
>
> Numeric ID of the release phase to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Requirement
>
> **Slug:** `AHA_UPDATE_REQUIREMENT`
>
> Update one requirement; provide at least one field to change.
>
> #### Input Parameters
>
> **name** `string`
>
> Replacement name.
>
> **end\_date** `string`
>
> Replacement end date in YYYY-MM-DD format.
>
> **start\_date** `string`
>
> Replacement start date in YYYY-MM-DD format.
>
> **description** `string`
>
> Replacement description, which may contain HTML.
>
> **requirement\_id** `string` *required*
>
> Requirement ID or reference number to update.
>
> **workflow\_status** `object`
>
> New workflow status, identified by name or ID.
>
> **assigned\_to\_user** `object`
>
> New assigned user, identified by email.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Roll-Up Release
>
> **Slug:** `AHA_UPDATE_ROLLUP_RELEASE`
>
> Update a roll-up release's name or add workspaces to it.
>
> #### Input Parameters
>
> **name** `string`
>
> Replacement roll-up release name.
>
> **project\_ids** `array`
>
> Workspace IDs or keys to add to the roll-up release.
>
> **rollup\_release\_id** `string` *required*
>
> Roll-up release numeric ID or reference number.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **body** `string`
>
> Replacement detailed description for the to-do; omit to leave it unchanged. At least one of name or body is required.
>
> **name** `string`
>
> Replacement name for the to-do; omit to leave it unchanged. At least one of name or body is required.
>
> **todo\_id** `string` *required*
>
> Aha! task ID to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update User
>
> **Slug:** `AHA_UPDATE_USER`
>
> Update an Aha! user; provide a new name or enabled state.
>
> #### Input Parameters
>
> **enabled** `boolean`
>
> Whether the user can access Aha!.
>
> **user\_id** `string` *required*
>
> Aha! user ID.
>
> **last\_name** `string`
>
> New last name.
>
> **first\_name** `string`
>
> New first name.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update User Custom Roles
>
> **Slug:** `AHA_UPDATE_USER_CUSTOM_ROLES`
>
> Assign a custom role to an Aha! user for one product.
>
> #### Input Parameters
>
> **user\_id** `string` *required*
>
> Numeric ID of the user.
>
> **product\_id** `string` *required*
>
> Numeric ID of the product where the custom role applies.
>
> **custom\_role\_id** `string` *required*
>
> Numeric ID of the custom role to assign.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update User Product Roles
>
> **Slug:** `AHA_UPDATE_USER_PRODUCT_ROLES`
>
> Assign a product role to an Aha! user for one product.
>
> #### Input Parameters
>
> **role** `string ("product_owner" | "contributor" | "reviewer" | "viewer" | "none")` *required*
>
> Product role to assign: product\_owner, contributor, reviewer, viewer, or none.
>
> **user\_id** `string` *required*
>
> Numeric ID of the user.
>
> **product\_id** `string` *required*
>
> Numeric ID or key of the product where the role applies.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Workflow Status Time
>
> **Slug:** `AHA_UPDATE_WORKFLOW_STATUS_TIME`
>
> Update a workflow status interval. This endpoint requires activation by Aha! support.
>
> #### Input Parameters
>
> **workflow\_status\_time** `object` *required*
>
> Workflow status interval fields to update.
>
> **workflow\_status\_time\_id** `string` *required*
>
> Numeric ID of the workflow status interval to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
