Update a changelog

Understanding how to use FeatureOS API to build custom integrations.

Introduction

The FeatureOS update a changelog API allows you to update information about your changelogs. You can also update changelogs' associated data.

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

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

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

import requests

response = requests.put(
    'https://api.featureos.app/api/v3/changelogs/:id',
    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 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
feature_requests_ids	false	Array	The IDs of the feature requests to be added to the changelog.

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>",
      "description_markdown": "Go label your changelogs now! Go on, you can do it!",
      "locale": "en",
      "url": "https://feeback.featureos.app/changelogs/changelog-labels-is-now-live",
      "published": true,
      "published_on": "October 12th, 2021",
      "scheduled_published_at": null,
      "author": {
        "name": "S Jobs",
        "email": "[email protected]"
      },
      "labels": [],
      "feature_requests": [],
      "other_languages": [
        {
          "id": 1,
          "title": "¡Las etiquetas del registro de cambios ya están disponibles!",
          "locale": "es",
          "status": "draft"
        }
      ]
    }
  ]
}