SHshiprush
Ideas

Promote an idea

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.

put/ideas/{id}/promote

Request

  • Base URL
    https://company.aha.io/api/v1
  • Auth
    • OAuth 2
      Authorization codehttps://{account-domain}.aha.io/oauth/authorize
      Token URLhttps://{account-domain}.aha.io/oauth/token
    • or HTTP bearer
    • or API key in cookie session
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

idstring required

Id identifier

Request body

promotable_typestring
release_idinteger

Example request

{
  "promotable_type": "feature",
  "release_id": 278327321
}

Response

Successful operation

Example response

{
  "idea": {
    "id": "58056975",
    "name": "Idea 1",
    "reference_num": "PRJ1-I-1",
    "score": 15,
    "created_at": "2019-01-01T00:00:00.000Z",
    "updated_at": "2019-01-01T00:00:00.000Z",
    "product_id": "131414752",
    "votes": 1,
    "initial_votes": 0,
    "status_changed_at": "2019-01-01T00:00:00.000Z",
    "workflow_status": {
      "id": "1009437757",
      "name": "In progress",
      "position": 2,
      "complete": false,
      "color": "#ecdd8f",
      "workflow_status_category": {
        "id": "112353881",
        "name": "In progress"
      }
    },
    "description": {
      "id": "103757394",
      "body": "Description of idea 1",
      "notable_id": "58056975",
      "notable_type": "Ideas::Idea",
      "editor_version": 1,
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z",
      "attachments": []
    },
    "visibility": "Visible to all ideas portal users",
    "url": "https://company.aha.io/ideas/ideas/PRJ1-I-1",
    "resource": "https://company.aha.io/api/v1/ideas/PRJ1-I-1",
    "product": {
      "id": "131414752",
      "reference_prefix": "PRJ1",
      "name": "Project 1",
      "product_line": false,
      "created_at": "2019-01-01T00:00:00.000Z",
      "url": "https://company.aha.io/projects/PRJ1",
      "workspace_type": "product_workspace"
    },
    "created_by_user": {
      "id": "1020675218",
      "name": "Mary Humpty",
      "email": "no-reply@aha.io",
      "created_at": "2019-01-01T00:00:00.000Z",
      "updated_at": "2019-01-01T00:00:00.000Z"
    },
    "assigned_to_user": null,
    "feature": {
      "id": "6776881149492554846",
      "name": "Idea 1",
      "reference_num": "PRJ1-251",
      "created_at": "2019-01-01T00:00:00.000Z",
      "product_id": "131414752",
      "url": "https://company.aha.io/features/PRJ1-251",
      "resource": "https://company.aha.io/api/v1/features/PRJ1-251"
    },
    "endorsements_count": 1,
    "comments_count": 0,
    "score_facts": [
      {
        "id": "244026645",
        "value": 10,
        "name": "Effort"
      },
      {
        "id": "394452137",
        "value": 5,
        "name": "Benefit"
      }
    ],
    "tags": [
      "Infrastructure"
    ],
    "full_tags": [
      {
        "id": 775582684,
        "name": "Infrastructure",
        "color": "#7552e0"
      }
    ],
    "categories": [
      {
        "id": "972845454",
        "name": "Hard disk drive",
        "parent_id": 552935478,
        "project_id": 131414752,
        "created_at": "2019-01-01T00:00:00.000Z"
      }
    ],
    "themes": [],
    "custom_fields": [
      {
        "id": 585340588,
        "key": "component",
        "name": "Component",
        "updatedAt": "2019-01-01T00:00:00Z",
        "type": "array",
        "value": [
          "web"
        ]
      },
      {
        "id": 267687015,
        "key": "custom_scorecard_definition",
        "name": "Some custom scorecard definition",
        "updatedAt": "2019-01-01T00:00:00Z",
        "type": "scorecard",
        "value": 11,
        "score_facts": [
          {
            "id": "84642379",
            "value": 10,
            "name": "Effort"
          }
        ]
      },
      {
        "id": 193641455,
        "key": "text_field1",
        "name": "TextField1",
        "updatedAt": "2019-01-01T00:00:00Z",
        "type": "string",
        "value": "Cairo"
      },
      {
        "id": 310635095,
        "key": "text_field2",
        "name": "TextField2",
        "updatedAt": "2019-01-01T00:00:00Z",
        "type": "string",
        "value": "Rennes"
      },
      {
        "id": 800380718,
        "key": "upload",
        "name": "Upload",
        "updatedAt": "2019-01-01T00:00:00Z",
        "type": "attachment",
        "attachments": []
      }
    ],
    "custom_object_links": [
      {
        "key": "revenue",
        "name": "Revenue",
        "record_type": "CustomObjectRecord",
        "record_ids": [
          640362830
        ]
      },
      {
        "key": "submitters",
        "name": "Submitters",
        "record_type": "CustomObjectRecord",
        "record_ids": [
          640362830
        ]
      }
    ],
    "workflow_status_times": [
      {
        "status_id": "1009437757",
        "status_name": "In progress",
        "started_at": "2019-01-01T00:00:00.000Z",
        "ended_at": null
      }
    ],
    "submitted_idea_portal_record_url": "https://ideas.example.com/ideas/PRJ1-I-1",
    "integration_fields": []
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.