Update a release tag

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

Release tags are the workspace-level tag catalog for releases. Update a release tag. 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

The release tag id.

Body Parameters

commit_hash:optionalstring

The commit hash.

Maximum 255 characters. Nullable.

description:optionalstring

Free-form description.

Nullable.

git_tag:optionalstring

The git tag.

Maximum 255 characters. Nullable.

version:optionalstring

Version string, for example 1.4.0.

Maximum 255 characters.

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: commit_hash, created_at, created_by_id, description, git_tag, id, version.

Scopes

releases.tags: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	conflict	A business rule blocks the write — see the notes above.
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 tag

curl -X PATCH \
  "https://api.plane.so/api/v2/workspaces/my-team/releases/tags/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/" \
  -H "X-Api-Key: $PLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "commit_hash": "example",
  "description": "What this is for.",
  "git_tag": "example"
}'

import requests

response = requests.patch(
    "https://api.plane.so/api/v2/workspaces/my-team/releases/tags/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/",
    headers={"X-Api-Key": "your-api-key"},
    json={
        "commit_hash": "example",
        "description": "What this is for.",
        "git_tag": "example"
    },
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v2/workspaces/my-team/releases/tags/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/",
  {
    method: "PATCH",
    headers: {
      "X-Api-Key": "your-api-key",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      commit_hash: "example",
      description: "What this is for.",
      git_tag: "example",
    }),
  },
);
const data = await response.json();

Response200

{
  "commit_hash": "example",
  "created_at": "2026-01-14T09:22:41.478363Z",
  "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "description": "What this is for.",
  "git_tag": "example",
  "id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
  "version": "1.4.0"
}

Response404

{
  "type": "not_found",
  "code": "not_found",
  "detail": "No release tag matches the given query."
}