Create a project release link

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

Attach a URL to a project release.

A URL can appear only once on a release. Sending a URL the release already links to returns 400 invalid_request with an error on url. The same URL can be linked from other releases.

Adding a link needs both view and edit access to the release. If you can't view the release, the request returns 404. If you can view it but can't edit it, the request returns 403.

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 to attach the link to.

Body Parameters

title:requiredstring

The link's display title. Maximum 255 characters.

url:requiredstring (uri)

The target URL. Must be a valid URL, at most 200 characters, and not already linked on this release.

metadata:optionalobject

Free-form JSON to store with the link. Defaults to {}.

Response shaping

fields:optionalstring

Comma-separated list of fields to return. Unrequested keys are omitted from the response, not returned as null, so absent means "not requested" and null means "actually null". id always comes back whether or not you name it.

Pass all for every requestable field. An unknown name is a 400 that lists the valid set and suggests the closest match, so a typo can't silently cost you the saving.

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	Missing title or url, an invalid or too-long url, or a URL the release already links to.
401	unauthorized	Missing or invalid credentials.
402	payment_required	Project releases aren't enabled on your plan.
403	forbidden	You can view the release but your role in the project can't edit it, or your token scope doesn't allow this.
404	not_found	No release with this id in this project, you can't view the release, or no such workspace or project.
406	not_acceptable	The Accept header asks for a representation the API can't produce.
409	conflict	Another request added the same URL to 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.

Create a project release link

curl -X POST \
  "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/releases/3e8a1f52-7c4b-4d9e-a6f1-0b2c5d8e9f14/links/" \
  -H "X-Api-Key: $PLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "title": "GitHub release v4.2.0",
  "url": "https://github.com/acme/mobile/releases/tag/v4.2.0"
}'

import requests

response = requests.post(
    "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/releases/3e8a1f52-7c4b-4d9e-a6f1-0b2c5d8e9f14/links/",
    headers={"X-Api-Key": "your-api-key"},
    json={
        "title": "GitHub release v4.2.0",
        "url": "https://github.com/acme/mobile/releases/tag/v4.2.0",
    },
)
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/",
  {
    method: "POST",
    headers: {
      "X-Api-Key": "your-api-key",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      title: "GitHub release v4.2.0",
      url: "https://github.com/acme/mobile/releases/tag/v4.2.0",
    }),
  },
);
const data = await response.json();

Response201

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

Response400

{
  "type": "invalid_request",
  "code": "invalid_request",
  "detail": "One or more fields failed validation.",
  "errors": [
    {
      "field": "url",
      "code": "invalid",
      "message": "URL already exists for this release."
    }
  ]
}