Skip to content

Update a post

Introduction

The FeatureOS update post API allows you to update a post in your organization.

PUT https://api.featureos.app/api/v3/feature_requests/:id

Headers

Parameter Default Description
API-KEY-Generate from organization settings on the admin dashboard.
ALLOW-PRIVATEfalseSet to true if filtering out a private board’s posts.
Authorization-Generate a unique JWT token that is specific to a user

Body Parameters

Parameter Format Description
titleStringThe title of the post. Also used to generate the slug.
descriptionTextThe description of the post. HTML is allowed.
attachments[]FileUpload up to 5 images that will be added to the end of the description. Each image can be either a 'jpeg', 'jpg', 'png' or 'gif' file and a max size of 10 MB.
bucket_idIntegerThe ID of the bucket returned in the list buckets endpoint. Needs ALLOW-PRIVATE header to be set if it is a private board ID.
approval_statusString'approved' - To approve the post, 'pending' - To move the post to pending
statusString'closed' - To close and approve the post
jira_issue_idStringThe Jira issue ID that needs to be linked to the post. Check the "linked_resource_details" object for the requested jira issue linking status.

Sample response

{
"id": 4230,
"slug": "good-bye-world",
"title": "Good bye world",
"preview": "",
"description": null,
"description_html": null,
"status": "Submitted",
"url": "https://feedback.featureos.app/b/api/p/good-bye-world",
"approval_status": "approved",
"submitter": {
"name": "Swathy",
"email": "[email protected]"
},
"bucket": {
"id": 14,
"name": "API"
},
"votes_count": 0,
"downvotes_count": 0,
"comments_count": 0,
"created_at": "2021-10-21T10:58:30.000Z",
"updated_at": "2021-10-21T10:58:31.000Z",
"tags": [],
"custom_status": {
"title": "In Progress",
"color": "#000000",
"status": "in_progress",
"percentage": null,
"icon": null
},
"linked_resource_details": {
"success_data": [
{
"source": "jira",
"issue_id": "123",
"title": "jira",
"url": "https://jira.com/issue/123"
}
],
"errors_data": [
{
"source": "jira",
"error": "Error fetching issue"
}
]
}
}