Update a release changelog

PATCH/api/v2/workspaces/{slug}/releases/{pk}/changelog/

Write the release notes of a workspace release. The API creates the changelog on demand, so you don't need to read it first.

PATCH is partial. Send description_html, description_json, or both. A field you omit keeps its stored value. The API stores each field as sent and doesn't derive one from the other, so send both when you want them to match.

Path Parameters

slug:requiredstring

The workspace slug. It appears in your Plane URLs. In https://app.plane.so/my-team/projects/, the slug is my-team.

pk:requiredstring (uuid)

The id of the release that owns the changelog.

Body Parameters

description_html:optionalstring

The changelog as HTML. Replaces the stored HTML. An empty string is allowed.

description_json:optionalobject

The changelog in the editor's JSON format. Replaces the stored JSON.

Scopes

releases:write

Errors

Status	Code	Cause
400	invalid_request	The request body or a query parameter failed validation.
401	unauthorized	Missing or invalid credentials.
402	payment_required	The feature this endpoint belongs to isn't enabled on your plan or is switched off.
403	forbidden	Your role or token scope doesn't allow this.
404	not_found	No such resource, or it's outside your tenant.
406	not_acceptable	The Accept header asks for a representation the API can't produce.
409	governance_migration_in_progress	A governance migration is running in this workspace, so writes are paused. Retry after it finishes.
413	payload_too_large	The request body is over the size limit.
415	unsupported_media_type	The Content-Type isn't one this endpoint accepts.
429	rate_limited	Throttled. Honor the Retry-After header before retrying.

Update a release changelog

curl -X PATCH \
  "https://api.plane.so/api/v2/workspaces/my-team/releases/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/changelog/" \
  -H "X-Api-Key: $PLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "description_html": "<p>Details go here.</p>"
}'

import requests

response = requests.patch(
    "https://api.plane.so/api/v2/workspaces/my-team/releases/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/changelog/",
    headers={"X-Api-Key": "your-api-key"},
    json={
        "description_html": "<p>Details go here.</p>"
    },
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v2/workspaces/my-team/releases/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/changelog/",
  {
    method: "PATCH",
    headers: {
      "X-Api-Key": "your-api-key",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      description_html: "<p>Details go here.</p>",
    }),
  },
);
const data = await response.json();

Response200

{
  "changelog_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "description_html": "<p>Details go here.</p>",
  "description_json": null,
  "id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
  "release_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f"
}

Response404

{
  "type": "not_found",
  "code": "not_found",
  "detail": "The requested resource was not found."
}