Update a release link

PATCH/api/v1/workspaces/{workspace_slug}/releases/{release_id}/links/{link_id}/

Updates an existing release link by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Path Parameters

workspace_slug:requiredstring

The workspace_slug represents the unique workspace identifier for a workspace in Plane. It can be found in the URL. For example, in the URL https://app.plane.so/my-team/projects/, the workspace slug is my-team.

release_id:requiredstring

The unique identifier for the release.

link_id:requiredstring

The unique identifier for the link.

Body Parameters

title:optionalstring

Title or description of the link.

url:optionalstring

URL of the external resource. Must be unique within the release.

metadata:optionalobject

Arbitrary metadata to store alongside the link.

Scopes

releases.links:write

Update a release link

curl -X PATCH \
  "https://api.plane.so/api/v1/workspaces/my-workspace/releases/a1b2c3d4-e5f6-7890-abcd-ef1234567890/links/b2c3d4e5-f6a7-8901-bcde-f23456789012/" \
  -H "X-API-Key: $PLANE_API_KEY" \
  # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "title": "Release notes (updated)",
  "url": "https://example.com/releases/v2.4.0/notes"
}'

import requests

response = requests.patch(
    "https://api.plane.so/api/v1/workspaces/my-workspace/releases/a1b2c3d4-e5f6-7890-abcd-ef1234567890/links/b2c3d4e5-f6a7-8901-bcde-f23456789012/",
    headers={"X-API-Key": "your-api-key"},
    json={
  'title': 'Release notes (updated)',
  'url': 'https://example.com/releases/v2.4.0/notes'
}
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v1/workspaces/my-workspace/releases/a1b2c3d4-e5f6-7890-abcd-ef1234567890/links/b2c3d4e5-f6a7-8901-bcde-f23456789012/",
  {
    method: "PATCH",
    headers: {
      "X-API-Key": "your-api-key",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      title: "Release notes (updated)",
      url: "https://example.com/releases/v2.4.0/notes",
    }),
  },
);
const data = await response.json();

Response200

{
  "id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
  "created_at": "2025-03-03T11:00:00.000000Z",
  "updated_at": "2025-03-03T11:20:00.000000Z",
  "deleted_at": null,
  "title": "Release notes (updated)",
  "url": "https://example.com/releases/v2.4.0/notes",
  "metadata": {},
  "created_by": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "updated_by": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "workspace": "cd4ab5a2-1a5f-4516-a6c6-8da1a9fa5be4",
  "release": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}