Skip to main content
Aha! logo
  • Category: product management
  • Auth: OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 112
  • Triggers: 0
  • Slug: AHA
  • Version: 20261101_00

Tools

Slug: AHA_ADD_PRODUCT_IDEA_PORTALSAdd idea portal links to a product without replacing existing links.

Input Parameters

string
required
Numeric ID or key of the product.
array
required
Idea portal IDs to add without removing existing links.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_CONVERT_FEATURE_TO_EPICIrreversibly convert an existing feature into an epic while preserving its data and relationships.

Input Parameters

string
required
Feature ID or reference number to convert into an epic.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_CONVERT_REQUIREMENT_TO_FEATUREIrreversibly convert an existing requirement into a feature.

Input Parameters

string
required
Requirement ID or reference number to convert into a feature.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_CREATE_CUSTOM_FIELD_OPTIONCreate an option for one custom-field definition.

Input Parameters

integer
Base-10 representation of the option’s hexadecimal RGB color.
string
required
Value displayed for the new option.
string
required
Custom-field definition ID that will own the option.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_CREATE_EPICCreate an epic in a release or in a workspace’s default release.

Input Parameters

string
required
Name of the epic.
string
Comma-separated tags to add to the epic.
array
Goal names or IDs to associate with the epic.
string
Due date in YYYY-MM-DD format.
string
Email address of the user creating the epic.
string
Initiative name or ID to associate with the epic.
string
Start date in YYYY-MM-DD format.
string
Epic description; HTML is accepted.
string
required
Release ID or workspace ID selected by destination_type.
string ("duration_manual" | "duration_from_features" | "duration_from_releases")
Method used to calculate epic dates.
string
Workflow status name valid for the workspace.
string
Email address of the user assigned to the epic.
string ("release" | "workspace_default_release")
required
Whether to create the epic in a release or a workspace’s default release.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_CREATE_FEATURECreate a feature in a release with its documented planning fields.

Input Parameters

string
Epic name or ID.
string
required
Name of the feature.
string
Comma-separated tags to add to the feature.
string
Team ID or key.
array
Goal names or IDs to associate with the feature.
string
Release ID or key to assign to the feature.
string
Due date in YYYY-MM-DD format.
string
Completion progress when progress_source is progress_manual.
string
Sprint ID.
string
Email address of the user who created the feature.
string
Initiative name or ID.
string
required
Release ID or reference number in which to create the feature.
string
Start date in YYYY-MM-DD format.
string
Feature description, which may contain HTML.
string
Release phase name or ID.
string
Feature workflow-kind identifier configured for the release’s workspace (for example, new); use AHA_LIST_WORKFLOWS to discover available values.
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.
object
Workflow status, identified by name or ID.
object
Assigned user, identified by email.
string
Initial estimate in the workspace’s configured capacity units.
string
Detailed estimate in the workspace’s configured capacity units.
string
Program increment ID or key.
string
Remaining estimate in the workspace’s configured capacity units.
string
Valid team status.
string
Initial estimate using time units (for example, 2d 1h) or story points (for example, 4p).
string
Detailed estimate using time units or story points.
string
Remaining estimate using time units or story points.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_CREATE_GOALCreate a strategic goal in one Aha! workspace or product line.

Input Parameters

string
required
Name of the new goal.
integer
Value score from 1 to 100.
integer
Effort score from 1 to 100.
number
Manual completion percentage from 0 to 100.
array
Aha! user IDs to add as goal watchers.
string
Parent goal ID, when this goal rolls up.
string
required
Workspace or product-line ID or reference prefix.
object
Strategic time frame selected by ID or name.
string
Goal description; HTML is accepted.
array
Custom-field values to set on the goal.
object
required
Metric used to determine whether the goal succeeds.
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.
string
Goal workflow status name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_CREATE_IDEACreate an idea in a product with the documented idea fields.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_CREATE_IDEA_THEMECreate an idea theme in a product.

Input Parameters

string
required
Name of the idea theme.
string
required
Numeric ID or key of the product that will contain the theme.
object
Rich-text description attributes for the theme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_CREATE_INITIATIVECreate a strategic initiative in one Aha! workspace or product line.

Input Parameters

string
required
Name of the new initiative.
array
Associated goal IDs or names.
string
Business value of the initiative.
string
Effort required for the initiative.
string
End date in YYYY-MM-DD format.
integer
Initiative ordering position.
number
Manual completion percentage.
array
Aha! user IDs to add as watchers.
string
Parent initiative ID.
boolean
Whether to show the initiative on charts.
string
required
Workspace or product-line ID or reference prefix.
string
Start date in YYYY-MM-DD format.
object
Strategic time frame by ID or name.
string
Initiative description; HTML is accepted.
array
Custom-field values.
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.
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.
object
required
Initial workflow status by ID or name.
string
Email address of the assigned Aha! user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_CREATE_KEY_RESULTCreate a key result under one strategic goal.

Input Parameters

string
required
Name of the new key result.
string
required
Goal ID or reference number.
array
Aha! user IDs to add as watchers.
string
Key-result description; HTML is accepted.
array
Custom-field values.
string
Target metric value.
string
Current metric value.
string
Starting metric value.
object
Initial workflow status by name.
object
User assigned by email address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_CREATE_PARKING_LOT_RELEASECreate a parking-lot release in a workspace.

Input Parameters

string
required
Name of the parking-lot release.
array
Goal names or IDs to associate with the release.
string
Email address or ID of the release owner.
string
Release theme; HTML is accepted.
string
End date in YYYY-MM-DD format.
string
ID of the parent roll-up release.
string
required
Workspace ID in which to create the release.
string
Start date in YYYY-MM-DD format.
array
Initiative names or IDs to associate with the release.
string ("time" | "story_points")
Capacity units used by the release.
string
Workflow status name valid for the workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_CREATE_PRODUCTCreate an Aha! product workspace with a name, description, and reference prefix.

Input Parameters

string
required
Name of the new Aha! workspace.
string
required
Reference prefix for records in the workspace.
string
Description of the new workspace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_CREATE_PRODUCT_CONTRIBUTORCreate an Aha! contributor user associated with a product.

Input Parameters

string
Product role for the new user.
string
required
Email address for the new user.
string
required
New user’s last name.
string
required
New user’s first name.
string
required
Aha! product ID or reference prefix.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_CREATE_PRODUCT_ROLLUP_RELEASECreate a roll-up release in a product line, optionally adding workspaces.

Input Parameters

string
required
Name of the new roll-up release.
string
Roll-up release theme; HTML is accepted.
string
required
Product-line numeric ID or key.
array
Workspace IDs or keys to add to the roll-up release.
string
Roll-up release date in YYYY-MM-DD format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_CREATE_RELEASE_MILESTONECreate a phase or milestone in an Aha! release.

Input Parameters

string
required
Name of the release milestone.
string
Milestone end date in YYYY-MM-DD format.
string
Completed progress; valid only when progress_source is progress_manual.
string
Milestone start date in YYYY-MM-DD format.
string ("phase" | "milestone")
required
Release phase type: phase or milestone.
string
required
ID of the release that will contain the milestone.
string
Description of the release milestone; HTML is accepted.
string ("duration_manual" | "duration_from_features")
Method used to calculate milestone dates.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_CREATE_REQUIREMENTCreate a requirement within one feature.

Input Parameters

string
required
Name of the requirement.
string
Planned end date in YYYY-MM-DD format.
string
required
Feature ID or reference number in which to create the requirement.
string
Planned start date in YYYY-MM-DD format.
string
Requirement description, which may contain HTML.
object
Workflow status, identified by name or ID.
object
Assigned user, identified by email.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_CREATE_TODOCreate a standalone personal to-do for the connected Aha! user.

Input Parameters

string
required
Detailed description for the to-do.
string
required
Short name for the new personal to-do.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_CREATE_WORKFLOW_STATUS_TIMECreate a workflow status interval for one supported parent record. This endpoint requires activation by Aha! support.

Input Parameters

string
required
ID of the parent record.
string ("epic" | "feature" | "idea" | "initiative" | "key_result" | "release" | "requirement")
required
Type of parent record whose status interval to create.
object
required
Workflow status interval to create.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_DELETE_CUSTOM_FIELD_OPTIONDelete one option from an Aha! custom-field definition; it may remain restorable through the recycle bin for up to 30 days.

Input Parameters

string
required
Numeric ID of the custom-field option to delete.
string
required
Numeric ID of the custom-field definition.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_DELETE_EPICDelete an epic by ID; it may remain restorable through the recycle bin for up to 30 days.

Input Parameters

string
required
Epic ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_DELETE_FEATUREDelete one feature by ID or reference number; it may remain restorable through the recycle bin for up to 30 days.

Input Parameters

string
required
Feature ID or reference number to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_DELETE_GOALDelete one strategic goal; it may remain restorable through the recycle bin for up to 30 days.

Input Parameters

string
required
Goal ID to delete.
string
required
Workspace or product-line ID or reference prefix.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_DELETE_IDEADelete an idea by ID or reference key; it may remain restorable through the recycle bin for up to 30 days.

Input Parameters

string
required
Numeric ID or reference key of the idea to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_DELETE_IDEA_THEMEDelete an idea theme by numeric ID; it may remain restorable through the recycle bin for up to 30 days.

Input Parameters

string
required
Numeric ID of the idea theme to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_DELETE_INITIATIVEDelete one strategic initiative; it may remain restorable through the recycle bin for up to 30 days.

Input Parameters

string
required
Workspace or product-line ID or reference prefix.
string
required
Initiative ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_DELETE_KEY_RESULTDelete one key result; it may remain restorable through the recycle bin for up to 30 days.

Input Parameters

string
required
Key-result ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_DELETE_RELEASEDelete a release from a workspace; it may remain restorable through the recycle bin for up to 30 days.

Input Parameters

string
required
Workspace ID containing the release.
string
required
Release ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_DELETE_RELEASE_PHASEDelete a release phase by numeric ID; it may remain restorable through the recycle bin for up to 30 days.

Input Parameters

string
required
Numeric ID of the release phase to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_DELETE_REQUIREMENTDelete one requirement by ID or reference number; it may remain restorable through the recycle bin for up to 30 days.

Input Parameters

string
required
Requirement ID or reference number to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_DELETE_TODODelete one to-do by its Aha! task ID; it may remain restorable through the recycle bin for up to 30 days.

Input Parameters

string
required
Aha! task ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_DELETE_USER_CUSTOM_ROLERemove a user’s custom role in one Aha! product.

Input Parameters

string
required
Numeric ID of the user.
string
required
Numeric ID of the product whose custom role to remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_DELETE_USER_PRODUCT_ROLERemove a user’s role in one Aha! product.

Input Parameters

string
required
Numeric ID of the user.
string
required
Numeric ID of the product whose role to remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_DELETE_WORKFLOW_STATUS_TIMEDelete a workflow status interval. This endpoint requires activation by Aha! support.

Input Parameters

string
required
Numeric ID of the workflow status interval to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_DUPLICATE_RELEASECreate a duplicate of an existing release.

Input Parameters

string
required
Release ID to duplicate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_GET_CURRENT_USERReturn the connected Aha! user, account context, and product roles.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_GET_CUSTOM_LAYOUTReturn one custom layout. Requires configuration-administrator access.

Input Parameters

string
required
Unique custom-layout ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_GET_EPICReturn one Aha! epic by its ID or reference number.

Input Parameters

string
required
Aha! epic ID or reference number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_GET_FEATUREReturn detailed information for one feature by internal ID or human-readable reference number.

Input Parameters

string
Comma-separated response fields to request; omit for the standard detailed shape.
string
required
Feature internal ID or human-readable reference number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_GET_GOALReturn one strategic goal by ID or reference number.

Input Parameters

string
required
Aha! goal ID or documented reference number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_GET_IDEAReturn one idea by ID or reference number.

Input Parameters

string
Comma-separated response fields to request; omit for the standard detailed shape.
string
required
Aha! idea ID or documented reference number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_GET_IDEA_THEMEReturn one idea theme by ID.

Input Parameters

string
required
Aha! idea theme ID or documented reference number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_GET_IDENTITY_PROVIDERReturn one identity provider configured for account SSO.

Input Parameters

string
required
Unique identity-provider ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_GET_INITIATIVEReturn one strategic initiative by ID or reference number.

Input Parameters

string
required
Aha! initiative ID or documented reference number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_GET_KEY_RESULTReturn one key result by ID.

Input Parameters

string
required
Aha! key result ID or documented reference number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_GET_RELEASEReturn one release by ID or reference number.

Input Parameters

string
required
Aha! release ID or documented reference number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_GET_RELEASE_PHASEReturn one release phase by ID.

Input Parameters

string
required
Aha! release phase ID or documented reference number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_GET_REQUIREMENTReturn one requirement by ID or reference number.

Input Parameters

string
required
Aha! requirement ID or documented reference number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_GET_ROLLUP_RELEASEReturn one roll-up release by ID or reference number.

Input Parameters

string
required
Roll-up release numeric ID or reference number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_GET_STRATEGIC_MODELReturn one strategic model by ID.

Input Parameters

string
required
Unique strategic-model ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_GET_STRATEGIC_VISIONReturn one strategic vision by ID.

Input Parameters

string
required
Unique strategic-vision ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_GET_TODOReturn one to-do by its Aha! task ID.

Input Parameters

string
Comma-separated response fields to request; omit for the standard detailed shape.
string
required
Aha! task ID returned by create or list to-dos.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_GET_USERGet a specific Aha! user by ID.

Input Parameters

string
required
Aha! user ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_GET_WORKFLOWReturn one workflow with its statuses and workflow kinds.

Input Parameters

string
required
Unique workflow ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_GET_WORKFLOW_STATUS_TIMEReturn one workflow status interval. The endpoint must be enabled by Aha! support.

Input Parameters

string
required
Unique workflow-status-time ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_GET_WORKSPACEReturn one workspace by ID, with applied template details when available or requested.

Input Parameters

string
Comma-separated response fields to request; omit for the standard detailed shape.
string
required
Aha! workspace ID or documented reference number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_LIST_ALL_CUSTOM_FIELD_OPTIONSReturn all options configured for one custom-field definition.

Input Parameters

string
required
Custom-field definition ID whose options to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_LIST_ASSIGNED_RECORDSList one page of records assigned to the connected Aha! user, optionally by record type.

Input Parameters

string
Cursor from the previous page; omit initially.
integer
Maximum assigned records to return on this page.
string
Optional Aha! record type to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_LIST_ASSISTANT_USAGEReturn 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_LIST_AUDITSReturn one page of immutable Aha! record-change history, optionally filtered by the changed record or an associated parent record.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_LIST_CHILD_RELEASESReturn releases under a roll-up release, one page at a time.

Input Parameters

string
Cursor from the previous call; omit for the first page.
integer
Maximum releases to return on this page (1-200).
string
required
Roll-up release ID whose child releases to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_LIST_CUSTOM_FIELD_OPTIONSReturn selectable options for one custom-field definition.

Input Parameters

string
required
Custom-field definition ID whose selectable options to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_LIST_CUSTOM_FIELDSReturn custom-field definitions, keys, types, and worksheet metadata.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_LIST_CUSTOM_LAYOUTSReturn custom layouts configured in the account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_LIST_DELETIONSReturn records currently visible in the account recycle bin, one page at a time.

Input Parameters

string
Continuation cursor returned by the previous call; omit for the first page.
integer
Maximum records to return on this page (1-200).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_LIST_EPICSReturn one page of epics across the account or within a goal, initiative, release, or workspace.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_LIST_FEATURESReturn one page of features across the account or within a goal, initiative, epic, workspace, or release.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_LIST_GOALSReturn one page of strategic goals across the account or within an initiative or product.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_LIST_IDEA_PORTALSReturn idea portals configured in the account or linked to one product, one page at a time.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_LIST_IDEASSearch and filter ideas across the account or within one product, returning one page at a time.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_LIST_IDEA_THEMESReturn idea themes across the account, one page at a time.

Input Parameters

string
Page cursor returned by the previous call; omit for the first page.
integer
Maximum records to return on this page (1-200).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_LIST_IDENTITY_PROVIDERSReturn active identity providers available for account SSO.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_LIST_INITIATIVESReturn one page of strategic initiatives across the account or within a goal or product.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_LIST_KEY_RESULTSReturn key results for one strategic goal, one page at a time.

Input Parameters

string
Page cursor returned by the previous call; omit for the first page.
string
required
Goal ID or reference number whose key results to return.
integer
Maximum records to return on this page (1-200).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_LIST_MY_PENDING_TODOSDeprecated compatibility action that lists one page of pending to-dos assigned to the connected Aha! user.

Input Parameters

string
Cursor from the previous page; omit initially.
integer
Maximum pending to-dos to return on this page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_LIST_PRODUCT_ROLLUP_RELEASESReturn roll-up releases in one Aha! product line, one page at a time.

Input Parameters

string
Cursor from the previous call; omit for the first page.
integer
Maximum roll-up releases to return on this page (1-200).
string
required
Product-line numeric ID or key.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_LIST_PRODUCT_USERSList one page of users and roles associated with an Aha! product.

Input Parameters

string
Cursor from the previous page; omit initially.
integer
Maximum users to return on this page.
string
required
Aha! product ID or reference prefix.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_LIST_RELEASE_PHASESReturn release phases across the account or within one release, one page at a time.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_LIST_RELEASESReturn releases associated with a workspace, goal, or initiative, one page at a time.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_LIST_REQUIREMENTSReturn requirements for one feature, optionally updated since a timestamp, one page at a time.

Input Parameters

string
Page cursor returned by the previous call; omit for the first page.
integer
Maximum records to return on this page (1-200).
string
required
Feature ID or reference number whose requirements to return.
string
Return requirements updated at or after this ISO 8601 timestamp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_LIST_ROLLUP_CHILD_RELEASESReturn releases under a roll-up release, one page at a time.

Input Parameters

string
Cursor from the previous call; omit for the first page.
integer
Maximum releases to return on this page (1-200).
string
required
Roll-up release ID whose child releases to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_LIST_STRATEGY_MODELSReturn strategy models configured in the account, one page at a time.

Input Parameters

string
Page cursor returned by the previous call; omit for the first page.
integer
Maximum records to return on this page (1-200).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_LIST_STRATEGY_VISIONSReturn strategic vision records in the account, one page at a time.

Input Parameters

string
Page cursor returned by the previous call; omit for the first page.
integer
Maximum records to return on this page (1-200).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_LIST_TODOSReturn one page of account, assigned-user, or associated-record to-dos.

Input Parameters

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.
string
Page cursor returned by the previous call; omit for the first page.
string
Comma-separated response fields to request; omit for the standard to-do shape.
string
Legacy epic selector; use parent_type and parent_id.
string
Legacy idea selector; use parent_type and parent_id.
string
Aha! user ID; required only when view is assigned_user.
integer
Maximum records to return on this page (1-200).
string
Associated record ID or reference number; required only when view is associated_record.
string
Aha! to-do type to return, such as Approval.
string
Legacy feature selector; use parent_type and parent_id.
string
Legacy product selector; use parent_type and parent_id.
string
Legacy release selector; use parent_type and parent_id.
string ("epic" | "feature" | "idea" | "product" | "release" | "requirement")
Associated record type; required only when view is associated_record.
string
Return to-dos updated at or after this ISO 8601 timestamp.
string
Legacy requirement selector; use parent_type and parent_id.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_LIST_USER_CUSTOM_ROLESList one page of an Aha! user’s custom roles and their scopes.

Input Parameters

string
Cursor from the previous page; omit initially.
string
required
Aha! user ID.
integer
Maximum roles to return on this page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_LIST_USER_PRODUCT_ROLESList one page of an Aha! user’s roles in individual products.

Input Parameters

string
Cursor from the previous page; omit initially.
string
required
Aha! user ID.
integer
Maximum roles to return on this page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_LIST_USERSReturn account users and their seat and administrator flags, one page at a time.

Input Parameters

string
Page cursor returned by the previous call; omit for the first page.
integer
Maximum records to return on this page (1-200).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_LIST_WORKFLOWSReturn workflows and statuses configured for one workspace.

Input Parameters

string
required
Workspace ID whose workflows to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_LIST_WORKFLOW_STATUS_TIMESReturn workflow status intervals for one supported parent record, one page at a time. The endpoint must be enabled by Aha! support.

Input Parameters

string
Cursor from the previous call.
integer
Maximum intervals to return (1-200).
string
required
ID of the parent record.
string ("epic" | "feature" | "idea" | "initiative" | "key_result" | "release" | "requirement")
required
Type of parent record whose status intervals to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_LIST_WORKSPACESReturn Aha! workspaces and workspace lines available to the connected user, one page at a time.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_PROMOTE_IDEAPromote an idea to an epic, feature, initiative, or requirement.

Input Parameters

string
required
Numeric ID or reference key of the idea to promote.
string
Feature ID or key; required for requirement promotion.
string
Product ID or key; required for initiative promotion.
string
Release ID or key; required for feature or epic promotion.
string ("epic" | "feature" | "initiative" | "requirement")
required
Record type to create from the idea.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_REPLACE_PRODUCT_IDEA_PORTALSReplace every idea portal link on a product.

Input Parameters

string
required
Numeric ID or key of the product.
array
required
Complete set of idea portal IDs to link; use an empty array to unlink all portals.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_RESTORE_DELETED_RECORDStart restoring a record from the recycle bin within its retention period; restoration may continue asynchronously.

Input Parameters

string
required
Deletion ID of the recycle-bin record to restore.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_UPDATE_CUSTOM_FIELD_OPTIONUpdate the value, color, or visibility of a custom-field option.

Input Parameters

integer
Base-10 representation of the option’s hexadecimal RGB color.
string
New value of the custom-field option.
boolean
Whether the option should be hidden.
string
required
Numeric ID of the custom-field option to update.
string
required
Numeric ID of the custom-field definition.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_UPDATE_EPICUpdate an epic by ID; provide at least one field to change.

Input Parameters

string
Replacement epic name.
string
Replacement comma-separated tags.
array
Complete replacement list of associated goal names or IDs.
string
required
Epic ID to update.
string
Release ID or key to which the epic should move.
string
Due date in YYYY-MM-DD format.
string
Replacement initiative name or ID.
string
Start date in YYYY-MM-DD format.
string
Replacement epic description; HTML is accepted.
string ("duration_manual" | "duration_from_features" | "duration_from_releases")
Method used to calculate epic dates.
string
Replacement workflow status name.
string
Replacement assignee email address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_UPDATE_FEATUREUpdate one feature’s planning fields; provide at least one field to change.

Input Parameters

string
Epic name or ID.
string
Replacement feature name.
string
Replacement comma-separated tags.
string
Replacement team ID or key.
array
Complete replacement list of associated goal names or IDs.
string
New release ID or key.
string
Due date in YYYY-MM-DD format.
string
Completion progress when progress_source is progress_manual.
string
Replacement sprint or iteration ID.
string
Creator email address.
string
required
Feature ID or reference number to update.
string
Initiative name or ID.
string
Start date in YYYY-MM-DD format.
string
Replacement HTML description.
string
Release phase name or ID.
string
Feature workflow-kind identifier configured for the release’s workspace (for example, new); use AHA_LIST_WORKFLOWS to discover available values.
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.
object
New workflow status.
object
New assignee by email.
string
Replacement initial estimate in configured capacity units.
string
Replacement detailed estimate in configured capacity units.
string
Replacement program increment ID or key.
string
Replacement remaining estimate in configured capacity units.
string
Replacement status valid for the selected team.
string
Replacement initial estimate using time units or story points.
string
Replacement detailed estimate using time units or story points.
string
Replacement remaining estimate using time units or story points.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_UPDATE_GOALUpdate one strategic goal; provide at least one field to change.

Input Parameters

string
Replacement goal name.
integer
Replacement value score from 1 to 100.
integer
Replacement effort score from 1 to 100.
string
required
Goal ID to update.
number
Manual completion percentage.
array
Complete replacement watcher ID list.
string
Replacement parent goal ID.
string
required
Workspace or product-line ID or reference prefix.
object
Replacement strategic time frame.
string
Replacement description; HTML is accepted.
array
Custom-field updates.
object
Success-metric updates.
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.
string
Replacement workflow status name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_UPDATE_IDEAUpdate an existing idea; provide at least one field to change.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_UPDATE_IDEA_THEMEUpdate an idea theme; provide a new name or description.

Input Parameters

string
New idea theme name.
string
required
Numeric ID of the idea theme to update.
object
New rich-text description attributes for the theme.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_UPDATE_INITIATIVEUpdate one strategic initiative; provide at least one field to change.

Input Parameters

string
Replacement initiative name.
array
Complete associated goal ID or name list.
string
Replacement business value.
string
Replacement effort value.
string
Replacement end date in YYYY-MM-DD format.
integer
Replacement ordering position.
number
Manual completion percentage.
array
Complete replacement watcher ID list.
string
Replacement parent initiative ID.
boolean
Whether to show the initiative on charts.
string
required
Workspace or product-line ID or reference prefix.
string
Replacement start date in YYYY-MM-DD format.
object
Replacement time frame by ID or name.
string
Replacement description; HTML is accepted.
array
Custom-field updates.
string
required
Initiative ID to update.
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.
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.
string
Replacement status by ID or name.
string
Assigned user’s email address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_UPDATE_KEY_RESULTUpdate one key result; provide at least one field to change.

Input Parameters

string
Replacement key-result name.
array
Complete replacement watcher ID list.
string
Replacement description; HTML is accepted.
array
Custom-field updates.
string
required
Key-result ID to update.
string
Replacement target metric.
string
Replacement current metric.
string
Replacement starting metric.
object
Replacement workflow status by name.
object
Replacement assignee by email.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_UPDATE_PRODUCTUpdate an Aha! product; provide a new name, description, or reference prefix.

Input Parameters

string
New product name.
string
required
ID or reference prefix of the Aha! product to update.
string
New product description.
string
New reference prefix for the product.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_UPDATE_RELEASEUpdate 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

string
Replacement release name.
array
Complete replacement list of associated goal names or IDs.
string
Replacement owner email address or ID.
string
Replacement release theme; HTML is accepted.
string
End date in YYYY-MM-DD format.
string
Completion percentage; valid when progress_source is progress_manual.
string
Replacement parent roll-up release ID.
string
required
Release numeric ID or key to update.
string
Start date in YYYY-MM-DD format.
array
Complete replacement list of associated initiative names or IDs.
boolean
Whether the release is a parking-lot release.
string
Release date in YYYY-MM-DD format.
string
Workspace numeric ID or key; when provided, use the workspace-nested route.
string ("time" | "story_points")
Replacement capacity units.
string ("duration_manual" | "duration_from_release_phases_features" | "duration_from_sub_releases")
Source used to calculate release dates.
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.
string
Replacement workflow status name.
string
Total capacity expressed in the configured capacity units.
string
External release date in YYYY-MM-DD format.
string
Date development started in YYYY-MM-DD format.
string ("sync" | "exact" | "week" | "month" | "quarter" | "half" | "year")
Resolution for the external release date.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_UPDATE_RELEASE_PHASEUpdate a release phase’s type and optionally its dates, description, or progress. The phase type is required on every update.

Input Parameters

string
Updated end date in YYYY-MM-DD format.
string
Completed progress; valid only when progress_source is progress_manual.
string
Updated start date in YYYY-MM-DD format.
string ("phase" | "milestone")
required
Release phase type: phase or milestone.
string
Updated release phase description; HTML is accepted.
string ("duration_manual" | "duration_from_features")
Method used to calculate release phase dates.
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.
string
required
Numeric ID of the release phase to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_UPDATE_REQUIREMENTUpdate one requirement; provide at least one field to change.

Input Parameters

string
Replacement name.
string
Replacement end date in YYYY-MM-DD format.
string
Replacement start date in YYYY-MM-DD format.
string
Replacement description, which may contain HTML.
string
required
Requirement ID or reference number to update.
object
New workflow status, identified by name or ID.
object
New assigned user, identified by email.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_UPDATE_ROLLUP_RELEASEUpdate a roll-up release’s name or add workspaces to it.

Input Parameters

string
Replacement roll-up release name.
array
Workspace IDs or keys to add to the roll-up release.
string
required
Roll-up release numeric ID or reference number.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_UPDATE_TODOUpdate an existing to-do’s name or description; provide at least one of name or body.

Input Parameters

string
Replacement detailed description for the to-do; omit to leave it unchanged. At least one of name or body is required.
string
Replacement name for the to-do; omit to leave it unchanged. At least one of name or body is required.
string
required
Aha! task ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_UPDATE_USERUpdate an Aha! user; provide a new name or enabled state.

Input Parameters

boolean
Whether the user can access Aha!.
string
required
Aha! user ID.
string
New last name.
string
New first name.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_UPDATE_USER_CUSTOM_ROLESAssign a custom role to an Aha! user for one product.

Input Parameters

string
required
Numeric ID of the user.
string
required
Numeric ID of the product where the custom role applies.
string
required
Numeric ID of the custom role to assign.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_UPDATE_USER_PRODUCT_ROLESAssign a product role to an Aha! user for one product.

Input Parameters

string ("product_owner" | "contributor" | "reviewer" | "viewer" | "none")
required
Product role to assign: product_owner, contributor, reviewer, viewer, or none.
string
required
Numeric ID of the user.
string
required
Numeric ID or key of the product where the role applies.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: AHA_UPDATE_WORKFLOW_STATUS_TIMEUpdate a workflow status interval. This endpoint requires activation by Aha! support.

Input Parameters

object
required
Workflow status interval fields to update.
string
required
Numeric ID of the workflow status interval to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not