Skip to content

Create a roadmap item

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
idtrueIntegerThe unique identifier of the roadmap.

Request Body

Parameter Required Type Description
feature_request_idtrueIntegerThe 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_idIntegerThe resource identifier for the roadmap item.
idIntegerUnique identifier for the roadmap item.
slugStringURL-friendly version of the roadmap item title.
titleStringThe title of the roadmap item.
post_keyStringThe post key identifier.
short_descriptionStringShort description of the roadmap item.
descriptionStringHTML formatted description of the roadmap item.
text_descriptionStringPlain text description of the roadmap item.
description_htmlStringHTML formatted description of the roadmap item.
sourceStringSource of the roadmap item (null if not specified).
post_created_atStringISO timestamp when the original post was created.
bucketObjectInformation about the bucket/category this item belongs to.
statusObjectCurrent status information of the roadmap item.
custom_statusObjectCustom status configuration for the roadmap item.
votes_count_numberIntegerNumber of upvotes for this item.
votes_countStringString representation of the vote count.
downvotes_count_numberIntegerNumber of downvotes for this item.
downvotes_countStringString representation of the downvote count.
downvotedBooleanWhether the current user has downvoted this item.
upvotedBooleanWhether the current user has upvoted this item.
assigneeObjectInformation about the user assigned to this item (null if not assigned).
etc_scheduledBooleanWhether an estimated time to completion is scheduled.
etc_dateStringEstimated time to completion date (null if not set).
submitterObjectInformation about the user who submitted this item.
scoreObjectScoring information for the roadmap item.
userObjectInformation about the user who created this roadmap item.