Create a comment

Understanding how to use FeatureOS API to build custom integrations.

Introduction

This endpoint allows you to create a new comment in your organization.

POST https://api.featureos.app/api/v3/comments

curl -X POST 'https://api.featureos.app/api/v3/comments' \
  -H 'API-KEY: YOUR_API_KEY' \
  -H 'Content-Type: application/json'

const response = await fetch('https://api.featureos.app/api/v3/comments', {
  method: 'POST',
  headers: {
    'API-KEY': 'YOUR_API_KEY',
    'Content-Type': 'application/json'
  }
});
const data = await response.json();

import requests

response = requests.post(
    'https://api.featureos.app/api/v3/comments',
    headers={
        'API-KEY': 'YOUR_API_KEY',
        'Content-Type': 'application/json'
    }
)
data = response.json()

Headers

Parameter	Default	Description
API-KEY	-	Generate from organization settings on the admin dashboard.
Authorization	-	Generate a unique JWT token that is specific to a user

Body Parameters

Parameter	Required	Format	Description
comment	true	String	The comment to be added.
attachments[]	false	File	Upload up to 5 images that will be added to the end of the comment. Each image can be either a 'jpeg', 'jpg', 'png' or 'gif' file and a max size of 10 MB.
internal	false	Boolean	If "true" it will be added as a internal comment.
feature_request_id	true	Integer	The ID of the feature_request in which the comment needs to be added.

Sample response

{
  "id": 1,
  "comment_html": "<p>Sample Comment 1</p>\n",
  "comment": "Sample Comment 1",
  "parent_id": null,
  "feature_request": {
    "id": 168181,
    "url": "https://feedback.featureos.app/b/feedback/p/hello-world",
    "title": "Comment created via API"
  },
  "pinned": false,
  "internal": false,
  "approval_status": "approved",
  "created_at": "2023-04-24T09:53:34.000Z",
  "updated_at": "2023-04-24T09:53:34.000Z",
  "author": {
    "id": 1,
    "name": "swathy",
    "email": "[email protected]",
    "profile_picture": {
      "url": null
    },
    "url": "https://feedback.featureos.app/admin/users?userId=1",
    "role": "admin"
  }
}