Update a release

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

Releases group shipped work and carry a changelog. Update a release. Send only the keys you want to change. Omitted keys keep their current value, and an explicit null clears a nullable field.

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 release id.

Body Parameters

description_html:optionalstring

The release description as HTML. Replaces the stored HTML.

description_json:optionalobject

The release description in the editor's JSON format. Replaces the stored JSON. Not nullable.

external_id:optionalstring

Your system's identifier for this record, for sync and import correlation.

Maximum 255 characters. Nullable.

external_source:optionalstring

The system external_id came from, for example github or jira.

Maximum 255 characters. Nullable.

is_latest:optionalboolean

Mark or unmark the release as the latest one. Plane doesn't limit the flag to one release, so setting it doesn't clear it on other releases.

is_prerelease:optionalboolean

Mark or unmark the release as a pre-release.

lead_id:optionalstring (uuid)

The user who leads the release. Must be an active member of the workspace. Send null to clear the lead.

name:optionalstring

New display name, unique across the workspace, project releases included. Maximum 255 characters.

release_date:optionalstring (date)

The date the release shipped, as YYYY-MM-DD. Nullable.

status:optionalstring

One of unreleased, released, or cancelled.

tag_id:optionalstring (uuid)

A release tag from the workspace tag catalog. Send null to clear the tag.

target_date:optionalstring (date)

The planned ship date, as YYYY-MM-DD. Nullable.

Response shaping

fields:optionalstring

Comma-separated list of fields to return. Unrequested keys are omitted, not returned as null. id always comes back. Pass all for every requestable field. An unknown name is a 400. See Sparse fields.

Requestable here: created_at, created_by_id, description_html, description_id, external_id, external_source, id, is_latest, is_prerelease, label_ids, lead_id, name, project_id, release_date, status, tag_id, target_date, updated_at, updated_by_id.

expand:optionalstring

Comma-separated relations to embed: lead, tag.

Expansion is separate-key — ?expand=state keeps state_id and adds a state object next to it. ?fields= and ?expand= are independent: naming a relation in ?fields= is a 400, and expanded objects survive field filtering. See Expanding relations.

Scopes

releases:write

Errors

Status	Code	Cause
400	invalid_request	The request body or a query parameter failed validation.
400	invalid_request	A name already used by another release in the workspace, project releases included.
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	conflict	Another request took the same name between validation and save.
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

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

import requests

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

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

Response200

{
  "id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
  "name": "Example name",
  "project_id": null,
  "description_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "description_html": "<p>Details go here.</p>",
  "status": "unreleased",
  "target_date": "2026-01-20",
  "release_date": "2026-01-20",
  "lead_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "tag_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "is_latest": false,
  "is_prerelease": false,
  "external_id": null,
  "external_source": null,
  "label_ids": ["16c61a3a-512a-48ac-b0be-b6b46fe6f430"],
  "created_at": "2026-01-14T09:22:41.478363Z",
  "updated_at": "2026-02-03T16:45:12.904117Z",
  "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "updated_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430"
}

Response404

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