update-link-detail.md

title	Update a link
description	Update a link via Plane API. HTTP PATCH request format, editable fields, and example responses.
keywords	plane api, update link, modify link, work item link, issue link, rest api, api integration

Update a link

PATCH /api/v1/workspaces/{workspace_slug}/projects/{project_id}/work-items/{work_item_id}/links/{link_id}

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

Path Parameters

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.

The unique identifier of the project.

The unique identifier for the work item.

The unique identifier for the link.

Body Parameters

Title or description of the link.

URL of the external resource.

Scopes

projects.work_items.links:write

curl -X PATCH \
  "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/links/{link_id}" \
  -H "X-API-Key: $PLANE_API_KEY" \
  # Or use -H "Authorization: Bearer $PLANE_OAUTH_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "example-name",
  "url": "example-url"
}'

import requests

response = requests.patch(
    "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/links/{link_id}",
    headers={"X-API-Key": "your-api-key"},
    json={
  'name': 'example-name',
  'url': 'example-url'
}
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v1/workspaces/my-workspace/projects/project-uuid/work-items/work-item-uuid/links/{link_id}",
  {
    method: "PATCH",
    headers: {
      "X-API-Key": "your-api-key",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
  "name": "example-name",
  "url": "example-url"
})
  }
);
const data = await response.json();

{
  "id": "project-uuid",
  "name": "Project Name",
  "identifier": "PROJ",
  "description": "Project description",
  "created_at": "2024-01-01T00:00:00Z"
}