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.

Promote an idea

PUT /api/v1/ideas/:id/promote

id *

Numeric ID or key of the idea

promotable_type *

Specify what to promote the idea to. Allowed values: epic, feature, initiative, requirement


Numeric ID or key of a release. Required when promoting to features/epics.


Numeric ID or key of a feature. Required when promoting to requirements.


Numeric ID or key of the product. Required when promoting to initiatives.

Example request

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

Example CURL command

curl "" -d '{"promotable_type":"feature","release_id":278327321}' -X PUT \
	-H "Authorization: Bearer 15b60d42d4bc417284a246ced6877b0bf13fb4aca415f7b55f7006bc3694a8ab" \
	-H "Content-Type: application/json" \
	-H "Accept: application/json"


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

Request body


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

Response body