Update a collection

PATCH/api/v2/workspaces/{slug}/collections/{pk}/

Collections group wiki pages in a workspace. Update a collection. 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.

pk:requiredstring (uuid)

The collection id.

Body parameters

access:optionalstring

Who can see this.

is_default:optionalboolean

Make this the default for its parent. Setting it clears the flag on the previous default.

is_global:optionalboolean

Whether this lives at the workspace level rather than inside a project.

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.

sort_order:optionalnumber

Manual ordering weight. Lower sorts first.

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, created_at, created_by_id, id, is_default, is_global, logo_props, name, owned_by_id, page_ids, sort_order, updated_at, updated_by_id.

expand:optionalstring

Comma-separated relations to embed: owned_by.

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

wiki.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 collection

curl -X PATCH \
  "https://api.plane.so/api/v2/workspaces/my-team/collections/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/" \
  -H "X-Api-Key: $PLANE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "access": null,
  "is_default": false,
  "is_global": false
}'

import requests

response = requests.patch(
    "https://api.plane.so/api/v2/workspaces/my-team/collections/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/",
    headers={"X-Api-Key": "your-api-key"},
    json={
        "access": None,
        "is_default": False,
        "is_global": False
    },
)
print(response.json())

const response = await fetch(
  "https://api.plane.so/api/v2/workspaces/my-team/collections/9c1f0b3d-6d2e-4c9a-8b41-2f7e5a0d6c88/",
  {
    method: "PATCH",
    headers: {
      "X-Api-Key": "your-api-key",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      access: null,
      is_default: false,
      is_global: false,
    }),
  },
);
const data = await response.json();

Response200

{
  "access": 0,
  "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",
  "id": "b7e42a19-3c5d-4f80-9a26-8d1c0f4e7b53",
  "is_default": false,
  "is_global": false,
  "logo_props": null,
  "name": "Example name",
  "owned_by_id": "f960d3c2-8524-4a41-b8eb-055ce4be2a7f",
  "page_ids": ["16c61a3a-512a-48ac-b0be-b6b46fe6f430"],
  "sort_order": 65535
}

Response404

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