Introduction
This API allows you to add a feature request to a roadmap as a roadmap item. Note: This operation is only available for manual roadmaps, not for sync roadmaps.
POST https://api.featureos.app/api/v3/roadmaps/:id/roadmap_items
Headers
Parameter | Default | Description | |
---|---|---|---|
API-KEY | - | Generate from organization settings on the admin dashboard. |
Path Parameters
Parameter | Required | Type | Description |
---|---|---|---|
id | true | Integer | The unique identifier of the roadmap. |
Request Body
Parameter | Required | Type | Description |
---|---|---|---|
feature_request_id | true | Integer | The unique identifier of the feature request to add to the roadmap. |
Sample Request
{ "feature_request_id": 34274}
Sample Response
{ "resource_id": 32083, "id": 863, "slug": "direct-link-to-new-post", "title": "Direct link to new post", "post_key": "-244", "short_description": "Hi there, \nis it possible to get a direct URL to a page where users are able to submit a post? My target users are not so tech savvy so I think it would be much easier for them if I send them to the form directly. \nIf this feature already exists, please let me know. \nThanks!\n", "description": "<p>Hi there, </p>\n\n<p>is it possible to get a direct URL to a page where users are able to submit a post? My target users are not so tech savvy so I think it would be much easier for them if I send them to the form directly. </p>\n\n<p>If this feature already exists, please let me know. </p>\n\n<p>Thanks!</p>\n", "text_description": "Hi there, \n \nis it possible to get a direct URL to a page where users are able to submit a post? My target users are not so tech savvy so I think it would be much easier for them if I send them to the form directly. \n \nIf this feature already exists, please let me know. \n \nThanks!\n\n", "description_html": "<p>Hi there, </p>\n\n<p>is it possible to get a direct URL to a page where users are able to submit a post? My target users are not so tech savvy so I think it would be much easier for them if I send them to the form directly. </p>\n\n<p>If this feature already exists, please let me know. </p>\n\n<p>Thanks!</p>\n", "source": null, "post_created_at": "2024-02-06T12:43:33.000Z", "bucket": { "id": 736, "name": "Updated New Private", "slug": "new-private" }, "status": { "title": "In Review1", "value": "under_review" }, "custom_status": { "title": "Evaluating", "value": "under_review", "color": "#1D4ED8", "status": "under_review", "percentage": 0.0, "icon": null }, "votes_count_number": 1, "votes_count": "1", "downvotes_count_number": 0, "downvotes_count": "0", "downvoted": false, "upvoted": false, "assignee": null, "etc_scheduled": false, "etc_date": null, "submitter": { "id": 127, "name": "Admin", "profile_picture": { "url": null }, "confirmed": true, "is_admin_of_organization": true, "is_member_of_organization": true, "is_csm_of_organization": true, "is_interactor": true, "user_labels": [], "email": "Masked Email" }, "score": { "aggregate": 0.0, "score_type": "rice", "reach": 0.0, "impact": 0.0, "confidence": 0.0, "effort_rice": 0.0 }, "user": { "id": 2, "name": "Admin", "profile_picture": { "url": null }, "confirmed": true, "is_admin_of_organization": true, "is_member_of_organization": true, "is_csm_of_organization": true, "is_interactor": true, "user_labels": [], "email": "Masked Email" }}
Response Fields
Field | Type | Description | |
---|---|---|---|
resource_id | Integer | The resource identifier for the roadmap item. | |
id | Integer | Unique identifier for the roadmap item. | |
slug | String | URL-friendly version of the roadmap item title. | |
title | String | The title of the roadmap item. | |
post_key | String | The post key identifier. | |
short_description | String | Short description of the roadmap item. | |
description | String | HTML formatted description of the roadmap item. | |
text_description | String | Plain text description of the roadmap item. | |
description_html | String | HTML formatted description of the roadmap item. | |
source | String | Source of the roadmap item (null if not specified). | |
post_created_at | String | ISO timestamp when the original post was created. | |
bucket | Object | Information about the bucket/category this item belongs to. | |
status | Object | Current status information of the roadmap item. | |
custom_status | Object | Custom status configuration for the roadmap item. | |
votes_count_number | Integer | Number of upvotes for this item. | |
votes_count | String | String representation of the vote count. | |
downvotes_count_number | Integer | Number of downvotes for this item. | |
downvotes_count | String | String representation of the downvote count. | |
downvoted | Boolean | Whether the current user has downvoted this item. | |
upvoted | Boolean | Whether the current user has upvoted this item. | |
assignee | Object | Information about the user assigned to this item (null if not assigned). | |
etc_scheduled | Boolean | Whether an estimated time to completion is scheduled. | |
etc_date | String | Estimated time to completion date (null if not set). | |
submitter | Object | Information about the user who submitted this item. | |
score | Object | Scoring information for the roadmap item. | |
user | Object | Information about the user who created this roadmap item. |