Create changelog

POST/workspaces/{organizationId}/changelog

Path parameters

organizationIdstringrequired

Request body

application/json

titlestringrequired

min length 1 · max length 300

bodystringrequired

min length 1 · max length 20000

labelsstring[]

max items 10

linksobject[]

max items 100

Show properties

Array of object

ticketIdstring

issueIdstring

publishboolean

Responses

201

Changelog entry created

entryobjectrequired

Show properties

idstringrequired

organizationIdstringrequired

titlestringrequired

bodystringrequired

labelsstringrequired

publishedAtstring | nullrequired

createdAtstringrequired

updatedAtstringrequired

linksobject[]required

Show properties

Array of object

idstringrequired

entryIdstringrequired

ticketIdstring | nullrequired

issueIdstring | nullrequired

Try it

Server

Custom base URLOverrides the selected server when set.

Parameters

organizationIdpath*

Bodyapplication/json

Request body

Request

curl -X POST '/workspaces/string/changelog' \
  -H 'Content-Type: application/json' \
  -d '{
  "title": "string",
  "body": "string",
  "labels": [
    "string"
  ],
  "links": [
    {
      "ticketId": "string",
      "issueId": "string"
    }
  ],
  "publish": true
}'

const response = await fetch("/workspaces/string/changelog", {
  method: "POST",
  headers: {
    "Content-Type": "application/json"
  },
  body: "{\n  \"title\": \"string\",\n  \"body\": \"string\",\n  \"labels\": [\n    \"string\"\n  ],\n  \"links\": [\n    {\n      \"ticketId\": \"string\",\n      \"issueId\": \"string\"\n    }\n  ],\n  \"publish\": true\n}"
});

import requests

response = requests.post(
    "/workspaces/string/changelog",
    headers={
        "Content-Type": "application/json"
    },
    data="{\n  \"title\": \"string\",\n  \"body\": \"string\",\n  \"labels\": [\n    \"string\"\n  ],\n  \"links\": [\n    {\n      \"ticketId\": \"string\",\n      \"issueId\": \"string\"\n    }\n  ],\n  \"publish\": true\n}",
)

Response

{
  "entry": {
    "id": "string",
    "organizationId": "string",
    "title": "string",
    "body": "string",
    "labels": "string",
    "publishedAt": "string",
    "createdAt": "string",
    "updatedAt": "string",
    "links": [
      {
        "id": "string",
        "entryId": "string",
        "ticketId": "string",
        "issueId": "string"
      }
    ]
  }
}