Update a project release link

PATCH/api/v2/workspaces/{slug}/projects/{project_id}/releases/{release_id}/links/{pk}/

Change a link's title, URL, or metadata.

PATCH is partial. Send only the fields you want to change. A new url must not match another link on the same release, or the request returns 400 with an error on url.

Updating needs edit access to the release, and returns 403 without it.

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.

project_id:requiredstring

The project the release belongs to. Accepts the project UUID or its bare identifier, for example ENG.

release_id:requiredstring (uuid)

The release the link is on.

pk:requiredstring (uuid)

The id of the link to update.

Body parameters

title:optionalstring

The link's display title. Maximum 255 characters.

url:optionalstring (uri)

The target URL. Must be a valid URL, at most 200 characters, and not used by another link on this release.

metadata:optionalobject

Free-form JSON to store with the link. Replaces the stored value.

Response shaping

fields:optionalstring

Comma-separated list of fields to return. Fields you don't request are left out of the response instead of coming back as null, so a missing key means you didn't ask for it and null means the value is null. id is always included, whether or not you name it.

Pass all to get every requestable field. An unknown field name returns 400 with the list of valid names and the closest match, so a typo is caught instead of being silently ignored.

Requestable here: created_at, created_by_id, id, metadata, release_id, title, updated_at, updated_by_id, url.

See Sparse fields.

Scopes

releases.links:write

Errors

Status	Code	Cause
400	invalid_request	An invalid or too-long url, a URL another link on the release uses, or a title over 255 characters.
401	unauthorized	Missing or invalid credentials.
402	payment_required	Project releases aren't enabled on your plan.
403	forbidden	Your role in the project can't edit this release, or your token scope doesn't allow this.
404	not_found	No such link on this release, or no such release in this project.
406	not_acceptable	The Accept header asks for a representation the API can't produce.
409	conflict	Another request took the same URL on the release 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 project release link

curl -X PATCH \
  "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/releases/3e8a1f52-7c4b-4d9e-a6f1-0b2c5d8e9f14/links/6c2e9a14-3d7b-4f85-a0e9-1b4d8c7f2e39/" \
  -H "X-Api-Key: $PLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "title": "Release notes on GitHub"
}'

import requests

response = requests.patch(
    "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/releases/3e8a1f52-7c4b-4d9e-a6f1-0b2c5d8e9f14/links/6c2e9a14-3d7b-4f85-a0e9-1b4d8c7f2e39/",
    headers={"X-Api-Key": "your-api-key"},
    json={"title": "Release notes on GitHub"},
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/releases/3e8a1f52-7c4b-4d9e-a6f1-0b2c5d8e9f14/links/6c2e9a14-3d7b-4f85-a0e9-1b4d8c7f2e39/",
  {
    method: "PATCH",
    headers: {
      "X-Api-Key": "your-api-key",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({ title: "Release notes on GitHub" }),
  },
);
const data = await response.json();

Response200

{
  "id": "6c2e9a14-3d7b-4f85-a0e9-1b4d8c7f2e39",
  "release_id": "3e8a1f52-7c4b-4d9e-a6f1-0b2c5d8e9f14",
  "title": "Release notes on GitHub",
  "url": "https://github.com/acme/mobile/releases/tag/v4.2.0",
  "metadata": {},
  "created_at": "2026-02-26T18:10:44.209631Z",
  "updated_at": "2026-02-27T09:02:15.384920Z",
  "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "updated_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430"
}