Create a changelog

Introduction

The FeatureOS create a changelog API allows you to create a changelog in your organization. You can also create changelogs' associated data.

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

Headers

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

Query Parameters

Parameter	Required	Format	Description
title	true	String	Title of the changelog (also used to create the slug)
description	false	Text	Details of the changelog (can be in HTML)
published	false	Boolean	Set to true if you want the changelog to be published immediately
scheduled_published_at	false	Date	Any valid date format is accepted as long as it is in the future

Sample response

{
  "changelogs": [
    {
      "id": 1,
      "title": "Changelog labels is now live!",
      "preview": "Go label your changelogs now!",
      "description": "<p>Go label your changelogs now! Go on, you can do it!</p>",
      "url": "https://feeback.featureos.app/changelogs/changelog-labels-is-now-live",
      "published": true,
      "published_on": "October 12th, 2021",
      "author": {
        "name": "S Jobs",
        "email": "[email protected]"
      },
      "labels": [],
      "feature_requests": []
    }
  ]
}