Create a release

POST/api/v2/workspaces/{slug}/releases/

Releases group shipped work and carry a changelog. Create a release.

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.

Body Parameters

name:requiredstring

Display name.

Maximum 255 characters.

description_html:optionalstring

Rich-text body as HTML. This is the field the Plane editor round-trips.

description_json:optionalstring

The description json.

external_id:optionalstring

Your system's identifier for this record, for sync and import correlation.

Maximum 255 characters. Nullable.

external_source:optionalstring

The system external_id came from, for example github or jira.

Maximum 255 characters. Nullable.

is_latest:optionalboolean

Whether is latest.

is_prerelease:optionalboolean

Whether is prerelease.

lead_id:optionalstring (uuid)

Id of the related lead.

Nullable.

release_date:optionalstring (date)

The release date.

Nullable.

status:optionalstring

• unreleased - Unreleased
• released - Released
• cancelled - Cancelled

One of unreleased, released, cancelled.

tag_id:optionalstring (uuid)

Id of the related tag.

Nullable.

target_date:optionalstring (date)

Planned due date, as YYYY-MM-DD.

Nullable.

Response shaping

fields:optionalstring

Comma-separated list of fields to return. Unrequested keys are omitted, not returned as null. id always comes back. Pass all for every requestable field. An unknown name is a 400. See Sparse fields.

Requestable here: created_at, created_by_id, description_html, description_id, external_id, external_source, id, is_latest, is_prerelease, label_ids, lead_id, name, release_date, status, tag_id, target_date.

expand:optionalstring

Comma-separated relations to embed: lead, tag.

Expansion is separate-key — ?expand=state keeps state_id and adds a state object next to it. ?fields= and ?expand= are independent: naming a relation in ?fields= is a 400, and expanded objects survive field filtering. See Expanding relations.

Scopes

releases:write

Errors

Status	Code	Cause
400	invalid_request	The request body or a query parameter failed validation.
401	unauthorized	Missing or invalid credentials.
402	payment_required	The feature this endpoint belongs to isn't enabled on your plan or is switched off.
403	forbidden	Your role or token scope doesn't allow this.
404	not_found	No such resource, or it's outside your tenant.
406	not_acceptable	The Accept header asks for a representation the API can't produce.
409	conflict	A business rule blocks the write — see the notes above.
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 release

curl -X POST \
  "https://api.plane.so/api/v2/workspaces/my-team/releases/" \
  -H "X-Api-Key: $PLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Example name",
  "description_html": "<p>Details go here.</p>",
  "description_json": null,
  "external_id": null
}'

import requests

response = requests.post(
    "https://api.plane.so/api/v2/workspaces/my-team/releases/",
    headers={"X-Api-Key": "your-api-key"},
    json={
        "name": "Example name",
        "description_html": "<p>Details go here.</p>",
        "description_json": None,
        "external_id": None
    },
)
print(response.json())

const response = await fetch("https://api.plane.so/api/v2/workspaces/my-team/releases/", {
  method: "POST",
  headers: {
    "X-Api-Key": "your-api-key",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    name: "Example name",
    description_html: "<p>Details go here.</p>",
    description_json: null,
    external_id: null,
  }),
});
const data = await response.json();

Response201

{
  "created_at": "2026-01-14T09:22:41.478363Z",
  "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "description_html": "<p>Details go here.</p>",
  "description_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "external_id": null,
  "external_source": null,
  "id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
  "is_latest": false,
  "is_prerelease": false,
  "label_ids": [["16c61a3a-512a-48ac-b0be-b6b46fe6f430"]],
  "lead_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "name": "Example name",
  "release_date": "2026-01-20",
  "status": "unreleased",
  "tag_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "target_date": "2026-01-20"
}