Ideas API

When creating an idea where the creator is an idea user we strongly suggest to provide the submitted_idea_portal_id attribute to the idea to ensure that the idea is created in the correct ideas portal and the user gets access to the portal.

If you don't want the idea to be submitted to any portal, you can skip this by setting skip_portal: true in the request body.

Update an idea's visibility

PUT /api/v1/ideas/:id

Parameters
Name	Description
`id *`	Numeric ID or key of the idea
`submitted_idea_portal_id`	Numeric ID of the ideas portal
`name`	Name of the idea
`description`	Description of the idea — may include HTML formatting.
`workflow_status`	Status of the idea — must be a valid status for the selected product.
`tags`	Tags to add to the idea. Multiple tags must be separated by commas.
`categories`	Names of any existing categories the idea should be assigned to. Multiple categories must be separated by commas.
`created_by *`	Email address of user who created the idea — does not need to be an Aha! user email.
`assigned_to_user`	Email address of user that is assigned the idea.
`feature`	Feature ID of the feature that the idea was promoted to
`initiative`	Initiative ID of the initiative that the idea was promoted to
`epic`	Epic ID of the epic that the idea was promoted to
`duplicate_idea`	Idea ID for an idea which this idea duplicates. Setting this value will merge this idea into the provided idea ID; setting it to a null or blank value will unmerge this idea. Note that in the API response, this attribute is called duplicate_of.
`initial_votes`	Number of votes to seed the vote count with when importing from other systems
`visibility`	Initial visibility of the idea (aha, creator, employee, employee_or_creator, creator_organization, or public - aha is the default)
`created_at`	Date of idea creation. In UTC timezone with format YYYY-MM-DD or YYYY-MM-DD HH:MM:SS.
`spam`	Whether the idea is considered spam. Must be 'true' or 'false'

Example request

PUT /api/v1/ideas/PRJ1-I-1

Example CURL command

curl "https://company.aha.io/api/v1/ideas/PRJ1-I-1" -d '{"idea":{"visibility":"public"}}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"

Request

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

Request body

Response

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

Response body