Create a project release

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

Create a release that belongs to the project in the path. The response is the new release with project_id set to that project. The project is fixed after creation. No later request moves the release to another project or turns it into a workspace release.

Release names are unique across the whole workspace, not only within the project. Reusing the name of any release in the workspace, a workspace release included, returns 400 invalid_request with an error on name.

This endpoint needs the project releases entitlement on your plan. It doesn't check the workspace Releases setting (is_release_enabled), which gates only Create a release for workspace releases.

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 to create the release in. Accepts the project UUID or its bare identifier, for example ENG.

Body Parameters

name:requiredstring

Display name for the release, unique across the workspace. Maximum 255 characters.

status:optionalstring

Where the release is in its lifecycle. One of unreleased, released, or cancelled. Defaults to unreleased.

target_date:optionalstring (date)

The planned ship date, as YYYY-MM-DD. Nullable.

release_date:optionalstring (date)

The date the release shipped, as YYYY-MM-DD. Nullable.

lead_id:optionalstring (uuid)

The user who leads the release. Must be an active member of the workspace. Otherwise, the request returns 400 with an error on lead_id. Nullable.

tag_id:optionalstring (uuid)

A release tag from the workspace tag catalog. An id that isn't a tag in this workspace returns 400. Nullable.

is_latest:optionalboolean

Mark the release as the latest one. Defaults to false.

is_prerelease:optionalboolean

Mark the release as a pre-release. Defaults to false.

description_html:optionalstring

The release description as HTML. Defaults to <p></p>.

description_json:optionalobject

The release description in the editor's JSON format. Defaults to {}. Not nullable.

external_id:optionalstring

Your system's identifier for this release, 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.

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, description_html, description_id, external_id, external_source, id, is_latest, is_prerelease, label_ids, lead_id, name, project_id, release_date, status, tag_id, target_date, updated_at, updated_by_id.

See Sparse fields.

expand:optionalstring

Comma-separated relations to embed alongside the ids: lead (the lead user) and tag (the release tag). See Expanding relations.

Scopes

releases:write

Errors

Status	Code	Cause
400	invalid_request	Missing name, a name already used in the workspace, a status outside the enum, an inactive lead_id, or an unknown tag_id.
401	unauthorized	Missing or invalid credentials.
402	payment_required	Project releases aren't enabled on your plan.
403	forbidden	You can't create releases in this project, or your token scope doesn't allow this.
404	not_found	No such workspace or project, or it's outside your tenant.
406	not_acceptable	The Accept header asks for a representation the API can't produce.
409	conflict	Another request took the same name 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.

Labels and work items come afterward

The create body has no label_ids or work item field. After you create the release, attach them with Add or remove project release labels and Add or remove project release work items.

Create a project release

curl -X POST \
  "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/releases/" \
  -H "X-Api-Key: $PLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Mobile 4.2.0",
  "description_html": "<p>Offline mode and the new onboarding flow.</p>",
  "target_date": "2026-02-27",
  "lead_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "tag_id": "a41c9e07-2f5d-4b83-8c6e-9d1f0a3b7c52"
}'

import requests

response = requests.post(
    "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/releases/",
    headers={"X-Api-Key": "your-api-key"},
    json={
        "name": "Mobile 4.2.0",
        "description_html": "<p>Offline mode and the new onboarding flow.</p>",
        "target_date": "2026-02-27",
        "lead_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
        "tag_id": "a41c9e07-2f5d-4b83-8c6e-9d1f0a3b7c52",
    },
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/releases/",
  {
    method: "POST",
    headers: {
      "X-Api-Key": "your-api-key",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      name: "Mobile 4.2.0",
      description_html: "<p>Offline mode and the new onboarding flow.</p>",
      target_date: "2026-02-27",
      lead_id: "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
      tag_id: "a41c9e07-2f5d-4b83-8c6e-9d1f0a3b7c52",
    }),
  },
);
const data = await response.json();

Response201

{
  "id": "3e8a1f52-7c4b-4d9e-a6f1-0b2c5d8e9f14",
  "name": "Mobile 4.2.0",
  "project_id": "4af68566-94a4-4eb3-94aa-50dc9427067b",
  "description_id": "5d2b7e91-4a3c-4f68-9e0d-1c7a8b2f6e35",
  "description_html": "<p>Offline mode and the new onboarding flow.</p>",
  "status": "unreleased",
  "target_date": "2026-02-27",
  "release_date": null,
  "lead_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "tag_id": "a41c9e07-2f5d-4b83-8c6e-9d1f0a3b7c52",
  "is_latest": false,
  "is_prerelease": false,
  "external_id": null,
  "external_source": null,
  "label_ids": [],
  "created_at": "2026-01-14T09:22:41.478363Z",
  "updated_at": "2026-01-14T09:22:41.478363Z",
  "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": "name",
      "code": "invalid",
      "message": "A release with this name already exists in the workspace."
    }
  ]
}