Update a project page

PATCH/api/v2/workspaces/{slug}/projects/{project_id}/pages/{pk}/

Update a project page, a document that lives inside a project. Send only the keys you want to change. Omitted keys keep their current value, and an explicit null clears a nullable field.

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

pk:requiredstring (uuid)

The project page id.

Body parameters

access:optionalstring

Who can see the page.

archived_at:optionalstring (date-time)

When the page was archived.

Nullable.

collection_id:optionalstring (uuid)

Id of the related collection.

Nullable.

color:optionalstring

Hex color used wherever this is rendered, for example #3f76ff.

Maximum 255 characters.

description_html:optionalstring

Rich-text body as HTML. The Plane editor reads and writes this field.

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_locked:optionalboolean

Prevents further edits to the content.

logo_props:optionalstring

Logo descriptor managed by the Plane editor. Send back the value you read instead of building it by hand.

name:optionalstring

Display name.

parent_id:optionalstring (uuid)

Id of the parent page.

Nullable.

sort_order:optionalnumber

Manual ordering weight. Lower sorts first.

view_props:optionalstring

Layout descriptor managed by the Plane editor. Send back the value you read.

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. id is always included. Pass all to get every requestable field. An unknown field name returns 400. See Sparse fields.

Requestable here: access, archived_at, collection_id, color, created_at, created_by_id, description_html, description_stripped, external_id, external_source, id, is_global, is_locked, logo_props, name, owned_by_id, parent_id, project_ids, sort_order, updated_at, updated_by_id, view_props.

expand:optionalstring

Comma-separated relations to embed: owned_by, parent.

Expanded objects get their own key: ?expand=state keeps state_id and adds a state object next to it. ?fields= and ?expand= work independently. Naming a relation in ?fields= returns 400, and field filtering never removes an expanded object. See Expanding relations.

Scopes

projects.pages: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.
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 page

curl -X PATCH \
  "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/pages/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/" \
  -H "X-Api-Key: $PLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "access": null,
  "archived_at": null,
  "collection_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f"
}'

import requests

response = requests.patch(
    "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/pages/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/",
    headers={"X-Api-Key": "your-api-key"},
    json={
        "access": None,
        "archived_at": None,
        "collection_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f"
    },
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v2/workspaces/my-team/projects/4af68566-94a4-4eb3-94aa-50dc9427067b/pages/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/",
  {
    method: "PATCH",
    headers: {
      "X-Api-Key": "your-api-key",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      access: null,
      archived_at: null,
      collection_id: "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
    }),
  },
);
const data = await response.json();

Response200

{
  "access": 0,
  "archived_at": null,
  "collection_id": null,
  "color": "#3f76ff",
  "created_at": "2026-01-14T09:22:41.478363Z",
  "updated_at": "2026-02-03T16:45:12.904117Z",
  "created_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "updated_by_id": "16c61a3a-512a-48ac-b0be-b6b46fe6f430",
  "description_html": "<p>Details go here.</p>",
  "description_stripped": "example",
  "external_id": null,
  "external_source": null,
  "id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
  "is_global": false,
  "is_locked": false,
  "logo_props": null,
  "name": "Example name",
  "owned_by_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "parent_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "project_ids": ["4af68566-94a4-4eb3-94aa-50dc9427067b"],
  "sort_order": 65535,
  "view_props": null
}

Response404

{
  "type": "not_found",
  "code": "not_found",
  "detail": "No project page matches the given query."
}