Update a release tag

PATCH/api/v1/workspaces/{workspace_slug}/releases/tags/{tag_id}/

Updates an existing release tag. Parameters you don't send are left unchanged. project is immutable after creation and cannot be changed here.

Path parameters

workspace_slug:requiredstring

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

tag_id:requiredstring

The unique identifier for the release tag.

Body parameters

version:optionalstring

Version string for the release tag, for example 2.4.0.

description:optionalstring

Plain text description of the release tag.

commit_hash:optionalstring

Commit hash the release tag points to.

git_tag:optionalstring

Name of the corresponding git tag, for example v2.4.0.

Scopes

releases.tags:write

Update a release tag

curl -X PATCH \
  "https://api.plane.so/api/v1/workspaces/my-workspace/releases/tags/tag-uuid/" \
  -H "X-API-Key: $PLANE_API_KEY" \
  # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "commit_hash": "a3f9c1d8e7b6054321fedcba9876543210abcd1",
  "git_tag": "v2.4.0"
}'

import requests

response = requests.patch(
    "https://api.plane.so/api/v1/workspaces/my-workspace/releases/tags/tag-uuid/",
    headers={"X-API-Key": "your-api-key"},
    json={
  'commit_hash': 'a3f9c1d8e7b6054321fedcba9876543210abcd1',
  'git_tag': 'v2.4.0'
}
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v1/workspaces/my-workspace/releases/tags/tag-uuid/",
  {
    method: "PATCH",
    headers: {
      "X-API-Key": "your-api-key",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      commit_hash: "a3f9c1d8e7b6054321fedcba9876543210abcd1",
      git_tag: "v2.4.0",
    }),
  },
);
const data = await response.json();

Response200

{
  "id": "9f8e7d6c-5b4a-3210-fedc-ba0987654321",
  "created_at": "2025-03-01T10:00:00.000000Z",
  "updated_at": "2025-03-06T08:45:00.000000Z",
  "deleted_at": null,
  "version": "2.4.0",
  "description": "Spring release tag",
  "commit_hash": "a3f9c1d8e7b6054321fedcba9876543210abcd1",
  "git_tag": "v2.4.0",
  "created_by": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "updated_by": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "workspace": "cd4ab5a2-1a5f-4516-a6c6-8da1a9fa5be4",
  "project": null
}